From 4d977cc9764ecf0073650f126700f6ff638fa06b Mon Sep 17 00:00:00 2001 From: xander Date: Thu, 1 Sep 2022 11:58:49 +0100 Subject: javadoc! added LongSliderController renamed Control -> Controller add minecraft simple option binding constructor --- src/main/java/dev/isxander/yacl/api/Binding.java | 31 +++++ .../java/dev/isxander/yacl/api/ButtonOption.java | 4 +- .../java/dev/isxander/yacl/api/ConfigCategory.java | 60 ++++++++++ src/main/java/dev/isxander/yacl/api/Control.java | 14 --- .../java/dev/isxander/yacl/api/Controller.java | 30 +++++ .../java/dev/isxander/yacl/api/NameableEnum.java | 3 + src/main/java/dev/isxander/yacl/api/Option.java | 93 +++++++++++++-- .../java/dev/isxander/yacl/api/OptionGroup.java | 45 +++++++- .../dev/isxander/yacl/api/YetAnotherConfigLib.java | 60 +++++++++- .../dev/isxander/yacl/api/utils/OptionUtils.java | 13 ++- .../dev/isxander/yacl/gui/OptionListWidget.java | 8 +- .../java/dev/isxander/yacl/gui/YACLScreen.java | 4 +- .../yacl/gui/controllers/ActionControl.java | 58 ---------- .../yacl/gui/controllers/ActionController.java | 87 ++++++++++++++ .../yacl/gui/controllers/ControlWidget.java | 125 -------------------- .../yacl/gui/controllers/ControllerWidget.java | 125 ++++++++++++++++++++ .../isxander/yacl/gui/controllers/EnumControl.java | 77 ------------- .../yacl/gui/controllers/EnumController.java | 110 ++++++++++++++++++ .../yacl/gui/controllers/TickBoxControl.java | 100 ---------------- .../yacl/gui/controllers/TickBoxController.java | 126 +++++++++++++++++++++ .../yacl/gui/controllers/package-info.java | 11 ++ .../controllers/slider/DoubleSliderControl.java | 72 ------------ .../controllers/slider/DoubleSliderController.java | 113 ++++++++++++++++++ .../gui/controllers/slider/FloatSliderControl.java | 72 ------------ .../controllers/slider/FloatSliderController.java | 113 ++++++++++++++++++ .../gui/controllers/slider/ISliderControl.java | 29 ----- .../gui/controllers/slider/ISliderController.java | 54 +++++++++ .../controllers/slider/IntegerSliderControl.java | 72 ------------ .../slider/IntegerSliderController.java | 111 ++++++++++++++++++ .../controllers/slider/LongSliderController.java | 111 ++++++++++++++++++ .../controllers/slider/SliderControlElement.java | 125 -------------------- .../slider/SliderControllerElement.java | 121 ++++++++++++++++++++ .../yacl/gui/controllers/slider/package-info.java | 10 ++ .../dev/isxander/yacl/impl/ButtonOptionImpl.java | 16 +-- .../java/dev/isxander/yacl/impl/OptionImpl.java | 16 +-- .../yacl/impl/utils/NumberFormatHelper.java | 38 +++++++ .../isxander/yacl/mixin/SimpleOptionAccessor.java | 11 ++ 37 files changed, 1487 insertions(+), 781 deletions(-) delete mode 100644 src/main/java/dev/isxander/yacl/api/Control.java create mode 100644 src/main/java/dev/isxander/yacl/api/Controller.java delete mode 100644 src/main/java/dev/isxander/yacl/gui/controllers/ActionControl.java create mode 100644 src/main/java/dev/isxander/yacl/gui/controllers/ActionController.java delete mode 100644 src/main/java/dev/isxander/yacl/gui/controllers/ControlWidget.java create mode 100644 src/main/java/dev/isxander/yacl/gui/controllers/ControllerWidget.java delete mode 100644 src/main/java/dev/isxander/yacl/gui/controllers/EnumControl.java create mode 100644 src/main/java/dev/isxander/yacl/gui/controllers/EnumController.java delete mode 100644 src/main/java/dev/isxander/yacl/gui/controllers/TickBoxControl.java create mode 100644 src/main/java/dev/isxander/yacl/gui/controllers/TickBoxController.java create mode 100644 src/main/java/dev/isxander/yacl/gui/controllers/package-info.java delete mode 100644 src/main/java/dev/isxander/yacl/gui/controllers/slider/DoubleSliderControl.java create mode 100644 src/main/java/dev/isxander/yacl/gui/controllers/slider/DoubleSliderController.java delete mode 100644 src/main/java/dev/isxander/yacl/gui/controllers/slider/FloatSliderControl.java create mode 100644 src/main/java/dev/isxander/yacl/gui/controllers/slider/FloatSliderController.java delete mode 100644 src/main/java/dev/isxander/yacl/gui/controllers/slider/ISliderControl.java create mode 100644 src/main/java/dev/isxander/yacl/gui/controllers/slider/ISliderController.java delete mode 100644 src/main/java/dev/isxander/yacl/gui/controllers/slider/IntegerSliderControl.java create mode 100644 src/main/java/dev/isxander/yacl/gui/controllers/slider/IntegerSliderController.java create mode 100644 src/main/java/dev/isxander/yacl/gui/controllers/slider/LongSliderController.java delete mode 100644 src/main/java/dev/isxander/yacl/gui/controllers/slider/SliderControlElement.java create mode 100644 src/main/java/dev/isxander/yacl/gui/controllers/slider/SliderControllerElement.java create mode 100644 src/main/java/dev/isxander/yacl/gui/controllers/slider/package-info.java create mode 100644 src/main/java/dev/isxander/yacl/impl/utils/NumberFormatHelper.java create mode 100644 src/main/java/dev/isxander/yacl/mixin/SimpleOptionAccessor.java (limited to 'src/main/java/dev') diff --git a/src/main/java/dev/isxander/yacl/api/Binding.java b/src/main/java/dev/isxander/yacl/api/Binding.java index 74120a0..d870d8c 100644 --- a/src/main/java/dev/isxander/yacl/api/Binding.java +++ b/src/main/java/dev/isxander/yacl/api/Binding.java @@ -1,10 +1,17 @@ package dev.isxander.yacl.api; import dev.isxander.yacl.impl.GenericBindingImpl; +import dev.isxander.yacl.mixin.SimpleOptionAccessor; +import net.minecraft.client.option.SimpleOption; +import org.apache.commons.lang3.Validate; import java.util.function.Consumer; import java.util.function.Supplier; +/** + * Controls modifying the bound option. + * Provides the default value, a setter and a getter. + */ public interface Binding { void setValue(T value); @@ -12,7 +19,31 @@ public interface Binding { T defaultValue(); + /** + * Creates a generic binding. + * + * @param def default value of the option, used to reset + * @param getter should return the current value of the option + * @param setter should set the option to the supplied value + */ static Binding of(T def, Supplier getter, Consumer setter) { + Validate.notNull(def, "`def` must not be null"); + Validate.notNull(getter, "`getter` must not be null"); + Validate.notNull(setter, "`setter` must not be null"); + return new GenericBindingImpl<>(def, getter, setter); } + + /** + * Creates a {@link Binding} for Minecraft's {@link SimpleOption} + */ + static Binding of(SimpleOption minecraftOption) { + Validate.notNull(minecraftOption, "`minecraftOption` must not be null"); + + return new GenericBindingImpl<>( + ((SimpleOptionAccessor) (Object) minecraftOption).getDefaultValue(), + minecraftOption::getValue, + minecraftOption::setValue + ); + } } diff --git a/src/main/java/dev/isxander/yacl/api/ButtonOption.java b/src/main/java/dev/isxander/yacl/api/ButtonOption.java index 08436b3..346bfa4 100644 --- a/src/main/java/dev/isxander/yacl/api/ButtonOption.java +++ b/src/main/java/dev/isxander/yacl/api/ButtonOption.java @@ -20,7 +20,7 @@ public interface ButtonOption extends Option { class Builder { private Text name; private final List tooltipLines = new ArrayList<>(); - private Function> controlGetter; + private Function> controlGetter; private Runnable action; private Builder() { @@ -48,7 +48,7 @@ public interface ButtonOption extends Option { return this; } - public Builder controller(@NotNull Function> control) { + public Builder controller(@NotNull Function> control) { Validate.notNull(control, "`control` cannot be null"); this.controlGetter = control; diff --git a/src/main/java/dev/isxander/yacl/api/ConfigCategory.java b/src/main/java/dev/isxander/yacl/api/ConfigCategory.java index 13552d6..b2bbf95 100644 --- a/src/main/java/dev/isxander/yacl/api/ConfigCategory.java +++ b/src/main/java/dev/isxander/yacl/api/ConfigCategory.java @@ -10,14 +10,29 @@ import org.apache.commons.lang3.Validate; import org.jetbrains.annotations.NotNull; import java.util.ArrayList; +import java.util.Collection; import java.util.List; import java.util.function.Function; +/** + * Separates {@link Option}s or {@link OptionGroup}s into multiple distinct sections. + * Served to a user as a button in the left column, + * upon pressing, the options list is filled with options contained within this category. + */ public interface ConfigCategory { + /** + * Name of category, displayed as a button on the left column. + */ @NotNull Text name(); + /** + * Gets every {@link OptionGroup} in this category. + */ @NotNull ImmutableList groups(); + /** + * Creates a builder to construct a {@link ConfigCategory} + */ static Builder createBuilder() { return new Builder(); } @@ -32,6 +47,11 @@ public interface ConfigCategory { } + /** + * Sets name of the category + * + * @see ConfigCategory#name() + */ public Builder name(@NotNull Text name) { Validate.notNull(name, "`name` cannot be null"); @@ -39,6 +59,14 @@ public interface ConfigCategory { return this; } + /** + * Adds an option to the root group of the category. + * To add to another group, use {@link Builder#group(OptionGroup)}. + * To construct an option, use {@link Option#createBuilder(Class)} + * + * @see ConfigCategory#groups() + * @see OptionGroup#isRoot() + */ public Builder option(@NotNull Option option) { Validate.notNull(option, "`option` must not be null"); @@ -46,6 +74,26 @@ public interface ConfigCategory { return this; } + /** + * Adds multiple options to the root group of the category. + * To add to another group, use {@link Builder#groups(Collection)}. + * To construct an option, use {@link Option#createBuilder(Class)} + * + * @see ConfigCategory#groups() + * @see OptionGroup#isRoot() + */ + public Builder options(@NotNull Collection> options) { + Validate.notEmpty(options, "`options` must not be empty"); + + this.rootOptions.addAll(options); + return this; + } + + /** + * Adds an option group. + * To add an option to the root group, use {@link Builder#option(Option)} + * To construct a group, use {@link OptionGroup#createBuilder()} + */ public Builder group(@NotNull OptionGroup group) { Validate.notNull(group, "`group` must not be null"); @@ -53,6 +101,18 @@ public interface ConfigCategory { return this; } + /** + * Adds multiple option groups. + * To add multiple options to the root group, use {@link Builder#options(Collection)} + * To construct a group, use {@link OptionGroup#createBuilder()} + */ + public Builder groups(@NotNull Collection groups) { + Validate.notEmpty(groups, "`groups` must not be empty"); + + this.groups.addAll(groups); + return this; + } + public ConfigCategory build() { Validate.notNull(name, "`name` must not be null to build `ConfigCategory`"); Validate.notEmpty(rootOptions, "`at least one option must be added to build `ConfigCategory`"); diff --git a/src/main/java/dev/isxander/yacl/api/Control.java b/src/main/java/dev/isxander/yacl/api/Control.java deleted file mode 100644 index 242b2c8..0000000 --- a/src/main/java/dev/isxander/yacl/api/Control.java +++ /dev/null @@ -1,14 +0,0 @@ -package dev.isxander.yacl.api; - -import dev.isxander.yacl.api.utils.Dimension; -import dev.isxander.yacl.gui.controllers.ControlWidget; -import net.minecraft.client.gui.screen.Screen; -import net.minecraft.text.Text; - -public interface Control { - Option option(); - - Text formatValue(); - - ControlWidget provideWidget(Screen screen, Dimension widgetDimension); -} diff --git a/src/main/java/dev/isxander/yacl/api/Controller.java b/src/main/java/dev/isxander/yacl/api/Controller.java new file mode 100644 index 0000000..2c0a5e1 --- /dev/null +++ b/src/main/java/dev/isxander/yacl/api/Controller.java @@ -0,0 +1,30 @@ +package dev.isxander.yacl.api; + +import dev.isxander.yacl.api.utils.Dimension; +import dev.isxander.yacl.gui.controllers.ControllerWidget; +import net.minecraft.client.gui.screen.Screen; +import net.minecraft.text.Text; +import org.jetbrains.annotations.ApiStatus; + +/** + * Provides a widget to control the option. + */ +public interface Controller { + /** + * Gets the dedicated {@link Option} for this controller + */ + Option option(); + + /** + * Gets the formatted value based on {@link Option#pendingValue()} + */ + Text formatValue(); + + /** + * Provides a widget to display + * + * @param screen parent screen + */ + @ApiStatus.Internal + ControllerWidget provideWidget(Screen screen, Dimension widgetDimension); +} diff --git a/src/main/java/dev/isxander/yacl/api/NameableEnum.java b/src/main/java/dev/isxander/yacl/api/NameableEnum.java index 12a58c3..9744ce9 100644 --- a/src/main/java/dev/isxander/yacl/api/NameableEnum.java +++ b/src/main/java/dev/isxander/yacl/api/NameableEnum.java @@ -2,6 +2,9 @@ package dev.isxander.yacl.api; import net.minecraft.text.Text; +/** + * Used for the default value formatter of {@link dev.isxander.yacl.gui.controllers.EnumController} + */ public interface NameableEnum { Text getDisplayName(); } diff --git a/src/main/java/dev/isxander/yacl/api/Option.java b/src/main/java/dev/isxander/yacl/api/Option.java index 5a98d50..6598b80 100644 --- a/src/main/java/dev/isxander/yacl/api/Option.java +++ b/src/main/java/dev/isxander/yacl/api/Option.java @@ -5,7 +5,6 @@ import net.minecraft.text.MutableText; import net.minecraft.text.Text; import org.apache.commons.lang3.Validate; import org.jetbrains.annotations.NotNull; -import org.jetbrains.annotations.Nullable; import java.util.ArrayList; import java.util.List; @@ -14,27 +13,70 @@ import java.util.function.Function; import java.util.function.Supplier; public interface Option { + /** + * Name of the option + */ @NotNull Text name(); - @Nullable Text tooltip(); - - @NotNull Control control(); - + /** + * Tooltip (or description) of the option. + * Rendered on hover. + */ + @NotNull Text tooltip(); + + /** + * Widget provider for a type of option. + * + * @see dev.isxander.yacl.gui.controllers + */ + @NotNull Controller controller(); + + /** + * Binding for the option. + * Controls setting, getting and default value. + * + * @see Binding + */ @NotNull Binding binding(); + /** + * Checks if the pending value is not equal to the current set value + */ boolean changed(); - T pendingValue(); + /** + * Value in the GUI, ready to set the actual bound value or be undone. + */ + @NotNull T pendingValue(); + /** + * Sets the pending value + */ void requestSet(T value); + /** + * Applies the pending value to the bound value. + * Cannot be undone. + */ void applyValue(); + /** + * Sets the pending value to the bound value. + */ void forgetPendingValue(); + /** + * Sets the pending value to the default bound value. + */ void requestSetDefault(); - static Builder createBuilder(Class clazz) { + /** + * Creates a builder to construct an {@link Option} + * + * @param type of the option's value + * @param typeClass used to capture the type + */ + static Builder createBuilder(Class typeClass) { return new Builder<>(); } @@ -43,7 +85,7 @@ public interface Option { private final List tooltipLines = new ArrayList<>(); - private Function, Control> controlGetter; + private Function, Controller> controlGetter; private Binding binding; @@ -51,6 +93,11 @@ public interface Option { } + /** + * Sets the name to be used by the option. + * + * @see Option#name() + */ public Builder name(@NotNull Text name) { Validate.notNull(name, "`name` cannot be null"); @@ -58,6 +105,13 @@ public interface Option { return this; } + /** + * Sets the tooltip to be used by the option. + * Can be invoked twice to append more lines. + * No need to wrap the text yourself, the gui does this itself. + * + * @param tooltips text lines - merged with a new-line on {@link Builder#build()}. + */ public Builder tooltip(@NotNull Text... tooltips) { Validate.notEmpty(tooltips, "`tooltips` cannot be empty"); @@ -65,13 +119,25 @@ public interface Option { return this; } - public Builder controller(@NotNull Function, Control> control) { + /** + * Sets the controller for the option. + * This is how you interact and change the options. + * + * @see dev.isxander.yacl.gui.controllers + */ + public Builder controller(@NotNull Function, Controller> control) { Validate.notNull(control, "`control` cannot be null"); this.controlGetter = control; return this; } + /** + * Sets the binding for the option. + * Used for default, getter and setter. + * + * @see Binding + */ public Builder binding(@NotNull Binding binding) { Validate.notNull(binding, "`binding` cannot be null"); @@ -79,6 +145,15 @@ public interface Option { return this; } + /** + * Sets the binding for the option. + * Shorthand of {@link Binding#of(Object, Supplier, Consumer)} + * + * @param def default value of the option, used to reset + * @param getter should return the current value of the option + * @param setter should set the option to the supplied value + * @see Binding + */ public Builder binding(@NotNull T def, @NotNull Supplier<@NotNull T> getter, @NotNull Consumer<@NotNull T> setter) { Validate.notNull(def, "`def` must not be null"); Validate.notNull(getter, "`getter` must not be null"); diff --git a/src/main/java/dev/isxander/yacl/api/OptionGroup.java b/src/main/java/dev/isxander/yacl/api/OptionGroup.java index bedbc82..6a302c4 100644 --- a/src/main/java/dev/isxander/yacl/api/OptionGroup.java +++ b/src/main/java/dev/isxander/yacl/api/OptionGroup.java @@ -5,18 +5,37 @@ import dev.isxander.yacl.impl.OptionGroupImpl; import net.minecraft.text.Text; import org.apache.commons.lang3.Validate; import org.jetbrains.annotations.NotNull; -import org.jetbrains.annotations.Nullable; import java.util.ArrayList; +import java.util.Collection; import java.util.List; +/** + * Serves as a separator between multiple chunks of options + * that may be too similar or too few to be placed in a separate {@link ConfigCategory}. + * Or maybe you just want your config to feel less dense. + */ public interface OptionGroup { + /** + * Name of the option group, displayed as a separator in the option lists. + * Can be empty. + */ Text name(); + /** + * List of all options in the group + */ @NotNull ImmutableList> options(); + /** + * Always false when using the {@link Builder} + * used to not render the separator if true + */ boolean isRoot(); + /** + * Creates a builder to construct a {@link OptionGroup} + */ static Builder createBuilder() { return new Builder(); } @@ -29,6 +48,11 @@ public interface OptionGroup { } + /** + * Sets name of the group, can be {@link Text#empty()} to just separate options, like sodium. + * + * @see OptionGroup#name() + */ public Builder name(@NotNull Text name) { Validate.notNull(name, "`name` must not be null"); @@ -36,6 +60,12 @@ public interface OptionGroup { return this; } + /** + * Adds an option to group. + * To construct an option, use {@link Option#createBuilder(Class)} + * + * @see OptionGroup#options() + */ public Builder option(@NotNull Option option) { Validate.notNull(option, "`option` must not be null"); @@ -43,6 +73,19 @@ public interface OptionGroup { return this; } + /** + * Adds multiple options to group. + * To construct an option, use {@link Option#createBuilder(Class)} + * + * @see OptionGroup#options() + */ + public Builder options(@NotNull Collection> options) { + Validate.notEmpty(options, "`options` must not be empty"); + + this.options.addAll(options); + return this; + } + public OptionGroup build() { Validate.notEmpty(options, "`options` must not be empty to build `OptionGroup`"); diff --git a/src/main/java/dev/isxander/yacl/api/YetAnotherConfigLib.java b/src/main/java/dev/isxander/yacl/api/YetAnotherConfigLib.java index a31a4fb..34ccc6a 100644 --- a/src/main/java/dev/isxander/yacl/api/YetAnotherConfigLib.java +++ b/src/main/java/dev/isxander/yacl/api/YetAnotherConfigLib.java @@ -10,21 +10,45 @@ import org.jetbrains.annotations.NotNull; import org.jetbrains.annotations.Nullable; import java.util.ArrayList; +import java.util.Collection; import java.util.List; import java.util.function.Consumer; +/** + * Main class of the mod. + * Contains all data and used to provide a {@link Screen} + */ public interface YetAnotherConfigLib { - + /** + * Title of the GUI. Only used for Minecraft narration. + */ Text title(); + /** + * Gets all config categories. + */ ImmutableList categories(); + /** + * Ran when changes are saved. Can be used to save config to a file etc. + */ Runnable saveFunction(); + /** + * Ran every time the YACL screen initialises. Can be paired with FAPI to add custom widgets. + */ Consumer initConsumer(); + /** + * Generates a Screen to display based on this instance. + * + * @param parent parent screen to open once closed + */ Screen generateScreen(@Nullable Screen parent); + /** + * Creates a builder to construct YACL + */ static Builder createBuilder() { return new Builder(); } @@ -39,6 +63,11 @@ public interface YetAnotherConfigLib { } + /** + * Sets title of GUI for Minecraft narration + * + * @see YetAnotherConfigLib#title() + */ public Builder title(@NotNull Text title) { Validate.notNull(title, "`title` cannot be null"); @@ -46,6 +75,12 @@ public interface YetAnotherConfigLib { return this; } + /** + * Adds a new category. + * To create a category you need to use {@link ConfigCategory#createBuilder()} + * + * @see YetAnotherConfigLib#categories() + */ public Builder category(@NotNull ConfigCategory category) { Validate.notNull(category, "`category` cannot be null"); @@ -53,6 +88,24 @@ public interface YetAnotherConfigLib { return this; } + /** + * Adds multiple categories at once. + * To create a category you need to use {@link ConfigCategory#createBuilder()} + * + * @see YetAnotherConfigLib#categories() + */ + public Builder categories(@NotNull Collection categories) { + Validate.notEmpty(categories, "`categories` cannot be empty"); + + this.categories.addAll(categories); + return this; + } + + /** + * Used to define a save function for when user clicks the Save Changes button + * + * @see YetAnotherConfigLib#saveFunction() + */ public Builder save(@NotNull Runnable saveFunction) { Validate.notNull(saveFunction, "`saveFunction` cannot be null"); @@ -60,6 +113,11 @@ public interface YetAnotherConfigLib { return this; } + /** + * Defines a consumer that is accepted every time the YACL screen initialises + * + * @see YetAnotherConfigLib#initConsumer() + */ public Builder screenInit(@NotNull Consumer initConsumer) { Validate.notNull(initConsumer, "`initConsumer` cannot be null"); diff --git a/src/main/java/dev/isxander/yacl/api/utils/OptionUtils.java b/src/main/java/dev/isxander/yacl/api/utils/OptionUtils.java index ed51683..ab46b5b 100644 --- a/src/main/java/dev/isxander/yacl/api/utils/OptionUtils.java +++ b/src/main/java/dev/isxander/yacl/api/utils/OptionUtils.java @@ -9,20 +9,29 @@ import java.util.function.Consumer; import java.util.function.Function; public class OptionUtils { + /** + * Consumes all options, ignoring groups and categories. + * When consumer returns true, this function stops iterating. + */ public static void consumeOptions(YetAnotherConfigLib yacl, Function, Boolean> consumer) { for (ConfigCategory category : yacl.categories()) { for (OptionGroup group : category.groups()) { for (Option option : group.options()) { - if (!consumer.apply(option)) return; + if (consumer.apply(option)) return; } } } } + /** + * Consumes all options, ignoring groups and categories. + * + * @see OptionUtils#consumeOptions(YetAnotherConfigLib, Function) + */ public static void forEachOptions(YetAnotherConfigLib yacl, Consumer> consumer) { consumeOptions(yacl, (opt) -> { consumer.accept(opt); - return true; + return false; }); } } diff --git a/src/main/java/dev/isxander/yacl/gui/OptionListWidget.java b/src/main/java/dev/isxander/yacl/gui/OptionListWidget.java index 6cb7090..e020065 100644 --- a/src/main/java/dev/isxander/yacl/gui/OptionListWidget.java +++ b/src/main/java/dev/isxander/yacl/gui/OptionListWidget.java @@ -4,7 +4,7 @@ import dev.isxander.yacl.api.ConfigCategory; import dev.isxander.yacl.api.Option; import dev.isxander.yacl.api.OptionGroup; import dev.isxander.yacl.api.utils.Dimension; -import dev.isxander.yacl.gui.controllers.ControlWidget; +import dev.isxander.yacl.gui.controllers.ControllerWidget; import net.minecraft.client.MinecraftClient; import net.minecraft.client.font.TextRenderer; import net.minecraft.client.gui.Element; @@ -25,7 +25,7 @@ public class OptionListWidget extends ElementListWidget if (!group.isRoot()) addEntry(new GroupSeparatorEntry(group)); for (Option option : group.options()) { - addEntry(new OptionEntry(option.control().provideWidget(screen, null))); + addEntry(new OptionEntry(option.controller().provideWidget(screen, null))); } } } @@ -40,9 +40,9 @@ public class OptionListWidget extends ElementListWidget } private static class OptionEntry extends Entry { - private final ControlWidget widget; + private final ControllerWidget widget; - public OptionEntry(ControlWidget widget) { + public OptionEntry(ControllerWidget widget) { this.widget = widget; } diff --git a/src/main/java/dev/isxander/yacl/gui/YACLScreen.java b/src/main/java/dev/isxander/yacl/gui/YACLScreen.java index 97cc8ed..aab047d 100644 --- a/src/main/java/dev/isxander/yacl/gui/YACLScreen.java +++ b/src/main/java/dev/isxander/yacl/gui/YACLScreen.java @@ -118,9 +118,9 @@ public class YACLScreen extends Screen { OptionUtils.consumeOptions(config, (option) -> { if (option.changed()) { pendingChanges.set(true); - return false; + return true; } - return true; + return false; }); return pendingChanges.get(); diff --git a/src/main/java/dev/isxander/yacl/gui/controllers/ActionControl.java b/src/main/java/dev/isxander/yacl/gui/controllers/ActionControl.java deleted file mode 100644 index 66e8e35..0000000 --- a/src/main/java/dev/isxander/yacl/gui/controllers/ActionControl.java +++ /dev/null @@ -1,58 +0,0 @@ -package dev.isxander.yacl.gui.controllers; - -import dev.isxander.yacl.api.ButtonOption; -import dev.isxander.yacl.api.Control; -import dev.isxander.yacl.api.utils.Dimension; -import net.minecraft.client.gui.screen.Screen; -import net.minecraft.text.Text; - -public class ActionControl implements Control { - private final ButtonOption option; - private final Text executeText; - - public ActionControl(ButtonOption option) { - this(option, Text.translatable("yacl.control.action.execute")); - } - - public ActionControl(ButtonOption option, Text executeText) { - this.option = option; - this.executeText = executeText; - - } - - @Override - public ButtonOption option() { - return option; - } - - @Override - public Text formatValue() { - return executeText; - } - - @Override - public ControlWidget provideWidget(Screen screen, Dimension widgetDimension) { - return new ActionControlElement(this, screen, widgetDimension); - } - - public static class ActionControlElement extends ControlWidget { - public ActionControlElement(ActionControl control, Screen screen, Dimension dim) { - super(control, screen, dim); - } - - @Override - public boolean mouseClicked(double mouseX, double mouseY, int button) { - if (isMouseOver(mouseX, mouseY)) { - playDownSound(); - control.option().action().run(); - return true; - } - return false; - } - - @Override - protected int getHoveredControlWidth() { - return getUnhoveredControlWidth(); - } - } -} diff --git a/src/main/java/dev/isxander/yacl/gui/controllers/ActionController.java b/src/main/java/dev/isxander/yacl/gui/controllers/ActionController.java new file mode 100644 index 0000000..b632c5f --- /dev/null +++ b/src/main/java/dev/isxander/yacl/gui/controllers/ActionController.java @@ -0,0 +1,87 @@ +package dev.isxander.yacl.gui.controllers; + +import dev.isxander.yacl.api.ButtonOption; +import dev.isxander.yacl.api.Controller; +import dev.isxander.yacl.api.utils.Dimension; +import net.minecraft.client.gui.screen.Screen; +import net.minecraft.text.Text; +import org.jetbrains.annotations.ApiStatus; + +/** + * Simple controller that simply runs the button action on press + * and renders a {@link} Text on the right. + */ +public class ActionController implements Controller { + public static final Text DEFAULT_TEXT = Text.translatable("yacl.control.action.execute"); + + private final ButtonOption option; + private final Text text; + + /** + * Constructs an action controller + * with the default formatter of {@link ActionController#DEFAULT_TEXT} + * + * @param option bound option + */ + public ActionController(ButtonOption option) { + this(option, DEFAULT_TEXT); + } + + /** + * Constructs an action controller + * + * @param option bound option + * @param text text to display + */ + public ActionController(ButtonOption option, Text text) { + this.option = option; + this.text = text; + + } + + /** + * {@inheritDoc} + */ + @Override + public ButtonOption option() { + return option; + } + + /** + * {@inheritDoc} + */ + @Override + public Text formatValue() { + return text; + } + + /** + * {@inheritDoc} + */ + @Override + public ControllerWidget provideWidget(Screen screen, Dimension widgetDimension) { + return new ActionControllerElement(this, screen, widgetDimension); + } + + @ApiStatus.Internal + public static class ActionControllerElement extends ControllerWidget { + public ActionControllerElement(ActionController control, Screen screen, Dimension dim) { + super(control, screen, dim); + } + + @Override + public boolean mouseClicked(double mouseX, double mouseY, int button) { + if (isMouseOver(mouseX, mouseY)) { + playDownSound(); + control.option().action().run(); + return true; + } + return false; + } + + @Override + protected int getHoveredControlWidth() { + return getUnhoveredControlWidth(); + } + } +} diff --git a/src/main/java/dev/isxander/yacl/gui/controllers/ControlWidget.java b/src/main/java/dev/isxander/yacl/gui/controllers/ControlWidget.java deleted file mode 100644 index be05ba4..0000000 --- a/src/main/java/dev/isxander/yacl/gui/controllers/ControlWidget.java +++ /dev/null @@ -1,125 +0,0 @@ -package dev.isxander.yacl.gui.controllers; - -import dev.isxander.yacl.api.Control; -import dev.isxander.yacl.api.utils.Dimension; -import dev.isxander.yacl.gui.AbstractWidget; -import net.minecraft.client.gui.DrawableHelper; -import net.minecraft.client.gui.screen.Screen; -import net.minecraft.client.gui.screen.narration.NarrationMessageBuilder; -import net.minecraft.client.util.math.MatrixStack; -import net.minecraft.text.OrderedText; -import net.minecraft.text.Text; - -import java.util.List; - -public abstract class ControlWidget> extends AbstractWidget { - protected final T control; - protected final List wrappedDescription; - - public Dimension dim; - protected final Screen screen; - - protected boolean hovered = false; - protected float hoveredTicks = 0; - - public ControlWidget(T control, Screen screen, Dimension dim) { - this.control = control; - this.dim = dim; - this.screen = screen; - this.wrappedDescription = textRenderer.wrapLines(control.option().tooltip(), screen.width / 2); - } - - @Override - public void render(MatrixStack matrices, int mouseX, int mouseY, float delta) { - hovered = isMouseOver(mouseX, mouseY); - if (hovered) { - hoveredTicks += delta; - } else { - hoveredTicks = 0; - } - - Text name = control.option().name(); - String nameString = name.getString(); - - boolean firstIter = true; - while (textRenderer.getWidth(nameString) > dim.width() - getControlWidth() - getXPadding() - 7) { - nameString = nameString.substring(0, nameString.length() - (firstIter ? 2 : 5)).trim(); - nameString += "..."; - - firstIter = false; - } - - Text shortenedName = Text.literal(nameString).fillStyle(name.getStyle()); - - drawButtonRect(matrices, dim.x(), dim.y(), dim.xLimit(), dim.yLimit(), hovered); - matrices.push(); - matrices.translate(dim.x() + getXPadding(), getTextY(), 0); - textRenderer.drawWithShadow(matrices, shortenedName, 0, 0, -1); - matrices.pop(); - - drawValueText(matrices); - if (hovered) { - drawHoveredControl(matrices, mouseX, mouseY, delta); - } - - if (hoveredTicks > 40) { - screen.renderOrderedTooltip(matrices, wrappedDescription, mouseX, mouseY); - } - } - - protected void drawHoveredControl(MatrixStack matrices, int mouseX, int mouseY, float delta) { - - } - - protected void drawValueText(MatrixStack matrices) { - Text valueText = control.formatValue(); - matrices.push(); - matrices.translate(dim.xLimit() - textRenderer.getWidth(valueText) - getXPadding(), getTextY(), 0); - textRenderer.drawWithShadow(matrices, valueText, 0, 0, -1); - matrices.pop(); - } - - @Override - public boolean isMouseOver(double mouseX, double mouseY) { - return this.dim.isPointInside((int) mouseX, (int) mouseY); - } - - protected int getControlWidth() { - return hovered ? getHoveredControlWidth() : getUnhoveredControlWidth(); - } - - protected abstract int getHoveredControlWidth(); - - protected int getUnhoveredControlWidth() { - return textRenderer.getWidth(control.formatValue()); - } - - protected int getXPadding() { - return 5; - } - - protected int getYPadding() { - return 2; - } - - protected void drawOutline(MatrixStack matrices, int x1, int y1, int x2, int y2, int width, int color) { - DrawableHelper.fill(matrices, x1, y1, x2, y1 + width, color); - DrawableHelper.fill(matrices, x2, y1, x2 - width, y2, color); - DrawableHelper.fill(matrices, x1, y2, x2, y2 - width, color); - DrawableHelper.fill(matrices, x1, y1, x1 + width, y2, color); - } - - protected float getTextY() { - return dim.y() + dim.height() / 2f - textRenderer.fontHeight / 2f; - } - - @Override - public SelectionType getType() { - return hovered ? SelectionType.HOVERED : SelectionType.NONE; - } - - @Override - public void appendNarrations(NarrationMessageBuilder builder) { - - } -} diff --git a/src/main/java/dev/isxander/yacl/gui/controllers/ControllerWidget.java b/src/main/java/dev/isxander/yacl/gui/controllers/ControllerWidget.java new file mode 100644 index 0000000..416ee42 --- /dev/null +++ b/src/main/java/dev/isxander/yacl/gui/controllers/ControllerWidget.java @@ -0,0 +1,125 @@ +package dev.isxander.yacl.gui.controllers; + +import dev.isxander.yacl.api.Controller; +import dev.isxander.yacl.api.utils.Dimension; +import dev.isxander.yacl.gui.AbstractWidget; +import net.minecraft.client.gui.DrawableHelper; +import net.minecraft.client.gui.screen.Screen; +import net.minecraft.client.gui.screen.narration.NarrationMessageBuilder; +import net.minecraft.client.util.math.MatrixStack; +import net.minecraft.text.OrderedText; +import net.minecraft.text.Text; + +import java.util.List; + +public abstract class ControllerWidget> extends AbstractWidget { + protected final T control; + protected final List wrappedTooltip; + + public Dimension dim; + protected final Screen screen; + + protected boolean hovered = false; + protected float hoveredTicks = 0; + + public ControllerWidget(T control, Screen screen, Dimension dim) { + this.control = control; + this.dim = dim; + this.screen = screen; + this.wrappedTooltip = textRenderer.wrapLines(control.option().tooltip(), screen.width / 2); + } + + @Override + public void render(MatrixStack matrices, int mouseX, int mouseY, float delta) { + hovered = isMouseOver(mouseX, mouseY); + if (hovered) { + hoveredTicks += delta; + } else { + hoveredTicks = 0; + } + + Text name = control.option().name(); + String nameString = name.getString(); + + boolean firstIter = true; + while (textRenderer.getWidth(nameString) > dim.width() - getControlWidth() - getXPadding() - 7) { + nameString = nameString.substring(0, nameString.length() - (firstIter ? 2 : 5)).trim(); + nameString += "..."; + + firstIter = false; + } + + Text shortenedName = Text.literal(nameString).fillStyle(name.getStyle()); + + drawButtonRect(matrices, dim.x(), dim.y(), dim.xLimit(), dim.yLimit(), hovered); + matrices.push(); + matrices.translate(dim.x() + getXPadding(), getTextY(), 0); + textRenderer.drawWithShadow(matrices, shortenedName, 0, 0, -1); + matrices.pop(); + + drawValueText(matrices); + if (hovered) { + drawHoveredControl(matrices, mouseX, mouseY, delta); + } + + if (hoveredTicks > 40) { + screen.renderOrderedTooltip(matrices, wrappedTooltip, mouseX, mouseY); + } + } + + protected void drawHoveredControl(MatrixStack matrices, int mouseX, int mouseY, float delta) { + + } + + protected void drawValueText(MatrixStack matrices) { + Text valueText = control.formatValue(); + matrices.push(); + matrices.translate(dim.xLimit() - textRenderer.getWidth(valueText) - getXPadding(), getTextY(), 0); + textRenderer.drawWithShadow(matrices, valueText, 0, 0, -1); + matrices.pop(); + } + + @Override + public boolean isMouseOver(double mouseX, double mouseY) { + return this.dim.isPointInside((int) mouseX, (int) mouseY); + } + + protected int getControlWidth() { + return hovered ? getHoveredControlWidth() : getUnhoveredControlWidth(); + } + + protected abstract int getHoveredControlWidth(); + + protected int getUnhoveredControlWidth() { + return textRenderer.getWidth(control.formatValue()); + } + + protected int getXPadding() { + return 5; + } + + protected int getYPadding() { + return 2; + } + + protected void drawOutline(MatrixStack matrices, int x1, int y1, int x2, int y2, int width, int color) { + DrawableHelper.fill(matrices, x1, y1, x2, y1 + width, color); + DrawableHelper.fill(matrices, x2, y1, x2 - width, y2, color); + DrawableHelper.fill(matrices, x1, y2, x2, y2 - width, color); + DrawableHelper.fill(matrices, x1, y1, x1 + width, y2, color); + } + + protected float getTextY() { + return dim.y() + dim.height() / 2f - textRenderer.fontHeight / 2f; + } + + @Override + public SelectionType getType() { + return hovered ? SelectionType.HOVERED : SelectionType.NONE; + } + + @Override + public void appendNarrations(NarrationMessageBuilder builder) { + + } +} diff --git a/src/main/java/dev/isxander/yacl/gui/controllers/EnumControl.java b/src/main/java/dev/isxander/yacl/gui/controllers/EnumControl.java deleted file mode 100644 index d032937..0000000 --- a/src/main/java/dev/isxander/yacl/gui/controllers/EnumControl.java +++ /dev/null @@ -1,77 +0,0 @@ -package dev.isxander.yacl.gui.controllers; - -import dev.isxander.yacl.api.Control; -import dev.isxander.yacl.api.NameableEnum; -import dev.isxander.yacl.api.Option; -import dev.isxander.yacl.api.utils.Dimension; -import net.minecraft.client.gui.screen.Screen; -import net.minecraft.text.Text; - -import java.util.function.Function; - -public class EnumControl> implements Control { - private final Option option; - private final Function valueFormatter; - private final Class enumClass; - - public EnumControl(Option option, Class enumClass) { - this(option, enumClass, value -> { - if (value instanceof NameableEnum nameableEnum) - return nameableEnum.getDisplayName(); - return Text.of(value.name()); - }); - } - - public EnumControl(Option option, Class enumClass, Function valueFormatter) { - this.option = option; - this.valueFormatter = valueFormatter; - this.enumClass = enumClass; - } - - @Override - public Option option() { - return option; - } - - @Override - public Text formatValue() { - return valueFormatter.apply(option().pendingValue()); - } - - @Override - public ControlWidget> provideWidget(Screen screen, Dimension widgetDimension) { - return new EnumControlElement<>(this, screen, widgetDimension, enumClass.getEnumConstants()); - } - - public static class EnumControlElement> extends ControlWidget> { - private final T[] values; - - public EnumControlElement(EnumControl control, Screen screen, Dimension dim, T[] values) { - super(control, screen, dim); - this.values = values; - } - - @Override - public boolean mouseClicked(double mouseX, double mouseY, int button) { - if (!isMouseOver(mouseX, mouseY) || (button != 0 && button != 1)) - return false; - - playDownSound(); - - int change = button == 1 || Screen.hasShiftDown() ? -1 : 1; - int targetIdx = control.option().pendingValue().ordinal() + change; - if (targetIdx >= values.length) { - targetIdx -= values.length; - } else if (targetIdx < 0) { - targetIdx += values.length; - } - control.option().requestSet(values[targetIdx]); - return true; - } - - @Override - protected int getHoveredControlWidth() { - return getUnhoveredControlWidth(); - } - } -} diff --git a/src/main/java/dev/isxander/yacl/gui/controllers/EnumController.java b/src/main/java/dev/isxander/yacl/gui/controllers/EnumController.java new file mode 100644 index 0000000..d88401c --- /dev/null +++ b/src/main/java/dev/isxander/yacl/gui/controllers/EnumController.java @@ -0,0 +1,110 @@ +package dev.isxander.yacl.gui.controllers; + +import dev.isxander.yacl.api.Controller; +import dev.isxander.yacl.api.NameableEnum; +import dev.isxander.yacl.api.Option; +import dev.isxander.yacl.api.utils.Dimension; +import net.minecraft.client.gui.screen.Screen; +import net.minecraft.text.Text; +import org.jetbrains.annotations.ApiStatus; + +import java.util.function.Function; + +/** + * Simple controller type that displays the enum on the right. + *

+ * Cycles forward with left click, cycles backward with right click or when shift is held + * + * @param enum type + */ +public class EnumController> implements Controller { + private final Option option; + private final Function valueFormatter; + private final Class enumClass; + + /** + * Constructs a cycling enum controller with a default value formatter. + * The default value formatter first searches if the + * enum is a {@link NameableEnum} else, just use {@link Enum#name()} + * + * @param option bound option + * @param enumClass class of enum + */ + public EnumController(Option option, Class enumClass) { + this(option, enumClass, value -> { + if (value instanceof NameableEnum nameableEnum) + return nameableEnum.getDisplayName(); + return Text.of(value.name()); + }); + } + + /** + * Constructs a cycling enum controller. + * + * @param option bound option + * @param enumClass class of enum + * @param valueFormatter format the enum into any {@link Text} + */ + public EnumController(Option option, Class enumClass, Function valueFormatter) { + this.option = option; + this.valueFormatter = valueFormatter; + this.enumClass = enumClass; + } + + /** + * {@inheritDoc} + */ + @Override + public Option option() { + return option; + } + + /** + * {@inheritDoc} + */ + @Override + public Text formatValue() { + return valueFormatter.apply(option().pendingValue()); + } + + /** + * {@inheritDoc} + */ + @Override + public ControllerWidget> provideWidget(Screen screen, Dimension widgetDimension) { + return new EnumControllerElement<>(this, screen, widgetDimension, enumClass.getEnumConstants()); + } + + @ApiStatus.Internal + public static class EnumControllerElement> extends ControllerWidget> { + private final T[] values; + + public EnumControllerElement(EnumController control, Screen screen, Dimension dim, T[] values) { + super(control, screen, dim); + this.values = values; + } + + @Override + public boolean mouseClicked(double mouseX, double mouseY, int button) { + if (!isMouseOver(mouseX, mouseY) || (button != 0 && button != 1)) + return false; + + playDownSound(); + + int change = button == 1 || Screen.hasShiftDown() ? -1 : 1; + int targetIdx = control.option().pendingValue().ordinal() + change; + if (targetIdx >= values.length) { + targetIdx -= values.length; + } else if (targetIdx < 0) { + targetIdx += values.length; + } + control.option().requestSet(values[targetIdx]); + return true; + } + + @Override + protected int getHoveredControlWidth() { + return getUnhoveredControlWidth(); + } + } +} diff --git a/src/main/java/dev/isxander/yacl/gui/controllers/TickBoxControl.java b/src/main/java/dev/isxander/yacl/gui/controllers/TickBoxControl.java deleted file mode 100644 index fb0e595..0000000 --- a/src/main/java/dev/isxander/yacl/gui/controllers/TickBoxControl.java +++ /dev/null @@ -1,100 +0,0 @@ -package dev.isxander.yacl.gui.controllers; - -import dev.isxander.yacl.api.Control; -import dev.isxander.yacl.api.Option; -import dev.isxander.yacl.api.utils.Dimension; -import net.minecraft.client.gui.DrawableHelper; -import net.minecraft.client.gui.screen.Screen; -import net.minecraft.client.util.math.MatrixStack; -import net.minecraft.text.Text; -import net.minecraft.util.Formatting; - -import java.util.function.Function; - -public class TickBoxControl implements Control { - - public static final Function ON_OFF_FORMATTER = (state) -> - state - ? Text.translatable("yacl.control.tickbox.on").formatted(Formatting.GREEN) - : Text.translatable("yacl.control.tickbox.off").formatted(Formatting.RED); - - public static final Function TRUE_FALSE_FORMATTER = (state) -> - state - ? Text.translatable("yacl.control.tickbox.true").formatted(Formatting.GREEN) - : Text.translatable("yacl.control.tickbox.false").formatted(Formatting.RED); - - public static final Function YES_NO_FORMATTER = (state) -> - state - ? Text.translatable("yacl.control.tickbox.yes").formatted(Formatting.GREEN) - : Text.translatable("yacl.control.tickbox.no").formatted(Formatting.RED); - - private final Option option; - private final Function valueFormatter; - - public TickBoxControl(Option option) { - this(option, ON_OFF_FORMATTER); - } - - public TickBoxControl(Option option, Function valueFormatter) { - this.option = option; - this.valueFormatter = valueFormatter; - - } - - @Override - public Option option() { - return option; - } - - @Override - public Text formatValue() { - return valueFormatter.apply(option().pendingValue()); - } - - @Override - public ControlWidget provideWidget(Screen screen, Dimension widgetDimension) { - return new TickBoxControlElement(this, screen, widgetDimension); - } - - public static class TickBoxControlElement extends ControlWidget { - private TickBoxControlElement(TickBoxControl control, Screen screen, Dimension dim) { - super(control, screen, dim); - } - - @Override - protected void drawHoveredControl(MatrixStack matrices, int mouseX, int mouseY, float delta) { - int outlineSize = 10; - int outlineX1 = dim.xLimit() - getXPadding() - outlineSize; - int outlineY1 = dim.centerY() - outlineSize / 2; - int outlineX2 = dim.xLimit() - getXPadding(); - int outlineY2 = dim.centerY() + outlineSize / 2; - drawOutline(matrices, outlineX1 + 1, outlineY1 + 1, outlineX2 + 1, outlineY2 + 1, 1, 0xFF404040); - drawOutline(matrices, outlineX1, outlineY1, outlineX2, outlineY2, 1, -1); - if (control.option().pendingValue()) { - DrawableHelper.fill(matrices, outlineX1 + 3, outlineY1 + 3, outlineX2 - 1, outlineY2 - 1, 0xFF404040); - DrawableHelper.fill(matrices, outlineX1 + 2, outlineY1 + 2, outlineX2 - 2, outlineY2 - 2, -1); - } - } - - @Override - protected void drawValueText(MatrixStack matrices) { - if (!hovered) - super.drawValueText(matrices); - } - - @Override - public boolean mouseClicked(double mouseX, double mouseY, int button) { - if (!isMouseOver(mouseX, mouseY)) - return false; - - control.option().requestSet(!control.option().pendingValue()); - playDownSound(); - return true; - } - - @Override - protected int getHoveredControlWidth() { - return 10; - } - } -} diff --git a/src/main/java/dev/isxander/yacl/gui/controllers/TickBoxController.java b/src/main/java/dev/isxander/yacl/gui/controllers/TickBoxController.java new file mode 100644 index 0000000..3bc5c22 --- /dev/null +++ b/src/main/java/dev/isxander/yacl/gui/controllers/TickBoxController.java @@ -0,0 +1,126 @@ +package dev.isxander.yacl.gui.controllers; + +import dev.isxander.yacl.api.Controller; +import dev.isxander.yacl.api.Option; +import dev.isxander.yacl.api.utils.Dimension; +import net.minecraft.client.gui.DrawableHelper; +import net.minecraft.client.gui.screen.Screen; +import net.minecraft.client.util.math.MatrixStack; +import net.minecraft.text.Text; +import net.minecraft.util.Formatting; +import org.jetbrains.annotations.ApiStatus; + +import java.util.function.Function; + +/** + * On hover, this controller renders a tickbox, otherwise, formatted {@link Text} + */ +public class TickBoxController implements Controller { + + public static final Function ON_OFF_FORMATTER = (state) -> + state + ? Text.translatable("yacl.control.tickbox.on").formatted(Formatting.GREEN) + : Text.translatable("yacl.control.tickbox.off").formatted(Formatting.RED); + + public static final Function TRUE_FALSE_FORMATTER = (state) -> + state + ? Text.translatable("yacl.control.tickbox.true").formatted(Formatting.GREEN) + : Text.translatable("yacl.control.tickbox.false").formatted(Formatting.RED); + + public static final Function YES_NO_FORMATTER = (state) -> + state + ? Text.translatable("yacl.control.tickbox.yes").formatted(Formatting.GREEN) + : Text.translatable("yacl.control.tickbox.no").formatted(Formatting.RED); + + private final Option option; + private final Function valueFormatter; + + /** + * Constructs a tickbox controller + * with the default value formatter of {@link TickBoxController#ON_OFF_FORMATTER} + * + * @param option bound option + */ + public TickBoxController(Option option) { + this(option, ON_OFF_FORMATTER); + } + + /** + * Constructs a tickbox controller + * + * @param option bound option + * @param valueFormatter format value into any {@link Text} + */ + public TickBoxController(Option option, Function valueFormatter) { + this.option = option; + this.valueFormatter = valueFormatter; + + } + + /** + * {@inheritDoc} + */ + @Override + public Option option() { + return option; + } + + /** + * {@inheritDoc} + */ + @Override + public Text formatValue() { + return valueFormatter.apply(option().pendingValue()); + } + + /** + * {@inheritDoc} + */ + @Override + public ControllerWidget provideWidget(Screen screen, Dimension widgetDimension) { + return new TickBoxControllerElement(this, screen, widgetDimension); + } + + @ApiStatus.Internal + public static class TickBoxControllerElement extends ControllerWidget { + private TickBoxControllerElement(TickBoxController control, Screen screen, Dimension dim) { + super(control, screen, dim); + } + + @Override + protected void drawHoveredControl(MatrixStack matrices, int mouseX, int mouseY, float delta) { + int outlineSize = 10; + int outlineX1 = dim.xLimit() - getXPadding() - outlineSize; + int outlineY1 = dim.centerY() - outlineSize / 2; + int outlineX2 = dim.xLimit() - getXPadding(); + int outlineY2 = dim.centerY() + outlineSize / 2; + drawOutline(matrices, outlineX1 + 1, outlineY1 + 1, outlineX2 + 1, outlineY2 + 1, 1, 0xFF404040); + drawOutline(matrices, outlineX1, outlineY1, outlineX2, outlineY2, 1, -1); + if (control.option().pendingValue()) { + DrawableHelper.fill(matrices, outlineX1 + 3, outlineY1 + 3, outlineX2 - 1, outlineY2 - 1, 0xFF404040); + DrawableHelper.fill(matrices, outlineX1 + 2, outlineY1 + 2, outlineX2 - 2, outlineY2 - 2, -1); + } + } + + @Override + protected void drawValueText(MatrixStack matrices) { + if (!hovered) + super.drawValueText(matrices); + } + + @Override + public boolean mouseClicked(double mouseX, double mouseY, int button) { + if (!isMouseOver(mouseX, mouseY)) + return false; + + control.option().requestSet(!control.option().pendingValue()); + playDownSound(); + return true; + } + + @Override + protected int getHoveredControlWidth() { + return 10; + } + } +} diff --git a/src/main/java/dev/isxander/yacl/gui/controllers/package-info.java b/src/main/java/dev/isxander/yacl/gui/controllers/package-info.java new file mode 100644 index 0000000..fcfc8e5 --- /dev/null +++ b/src/main/java/dev/isxander/yacl/gui/controllers/package-info.java @@ -0,0 +1,11 @@ +/** + * This package contains all {@link dev.isxander.yacl.api.Controller} implementations + * + *

    + *
  • For numbers: {@link dev.isxander.yacl.gui.controllers.slider}
    • + *
  • For booleans: {@link dev.isxander.yacl.gui.controllers.TickBoxController}
    • + *
  • For enums: {@link dev.isxander.yacl.gui.controllers.EnumController}
    • + *
  • For {@link dev.isxander.yacl.api.ButtonOption}: {@link dev.isxander.yacl.gui.controllers.ActionController}
    • + *
+ */ +package dev.isxander.yacl.gui.controllers; diff --git a/src/main/java/dev/isxander/yacl/gui/controllers/slider/DoubleSliderControl.java b/src/main/java/dev/isxander/yacl/gui/controllers/slider/DoubleSliderControl.java deleted file mode 100644 index 5aaa6c4..0000000 --- a/src/main/java/dev/isxander/yacl/gui/controllers/slider/DoubleSliderControl.java +++ /dev/null @@ -1,72 +0,0 @@ -package dev.isxander.yacl.gui.controllers.slider; - -import dev.isxander.yacl.api.Option; -import net.minecraft.text.Text; -import org.apache.commons.lang3.Validate; - -import java.util.function.Function; - -public class DoubleSliderControl implements ISliderControl { - public static final Function DEFAULT_FORMATTER = value -> Text.of(String.format("%.2f", value)); - - private final Option option; - - private final double min, max, interval; - - private final Function valueFormatter; - - public DoubleSliderControl(Option option, double min, double max, double interval) { - this(option, min, max, interval, DEFAULT_FORMATTER); - } - - public DoubleSliderControl(Option option, double min, double max, double interval, Function valueFormatter) { - Validate.isTrue(max > min, "`max` cannot be smaller than `min`"); - Validate.isTrue(interval > 0, "`interval` must be more than 0"); - - this.option = option; - this.min = min; - this.max = max; - this.interval = interval; - this.valueFormatter = valueFormatter; - } - - @Override - public Option option() { - return option; - } - - @Override - public Text formatValue() { - return valueFormatter.apply(option().pendingValue()); - } - - @Override - public double min() { - return min; - } - - @Override - public double max() { - return max; - } - - @Override - public double interval() { - return interval; - } - - @Override - public void setPendingValue(double value) { - option().requestSet(value); - } - - @Override - public double pendingValue() { - return option().pendingValue(); - } - - @Override - public Text getValueText(double value) { - return valueFormatter.apply(value); - } -} diff --git a/src/main/java/dev/isxander/yacl/gui/controllers/slider/DoubleSliderController.java b/src/main/java/dev/isxander/yacl/gui/controllers/slider/DoubleSliderController.java new file mode 100644 index 0000000..8d74ceb --- /dev/null +++ b/src/main/java/dev/isxander/yacl/gui/controllers/slider/DoubleSliderController.java @@ -0,0 +1,113 @@ +package dev.isxander.yacl.gui.controllers.slider; + +import dev.isxander.yacl.api.Option; +import net.minecraft.text.Text; +import org.apache.commons.lang3.Validate; + +import java.util.function.Function; + +/** + * {@link ISliderController} for doubles. + */ +public class DoubleSliderController implements ISliderController { + /** + * Formats doubles to two decimal places + */ + public static final Function DEFAULT_FORMATTER = value -> Text.of(String.format("%.2f", value)); + + private final Option option; + + private final double min, max, interval; + + private final Function valueFormatter; + + /** + * Constructs a {@link ISliderController} for doubles + * using the default value formatter {@link DoubleSliderController#DEFAULT_FORMATTER}. + * + * @param option bound option + * @param min minimum slider value + * @param max maximum slider value + * @param interval step size (or increments) for the slider + */ + public DoubleSliderController(Option option, double min, double max, double interval) { + this(option, min, max, interval, DEFAULT_FORMATTER); + } + + /** + * Constructs a {@link ISliderController} for doubles. + * + * @param option bound option + * @param min minimum slider value + * @param max maximum slider value + * @param interval step size (or increments) for the slider + * @param valueFormatter format the value into any {@link Text} + */ + public DoubleSliderController(Option option, double min, double max, double interval, Function valueFormatter) { + Validate.isTrue(max > min, "`max` cannot be smaller than `min`"); + Validate.isTrue(interval > 0, "`interval` must be more than 0"); + + this.option = option; + this.min = min; + this.max = max; + this.interval = interval; + this.valueFormatter = valueFormatter; + } + + /** + * {@inheritDoc} + */ + @Override + public Option option() { + return option; + } + + /** + * {@inheritDoc} + */ + @Override + public Text formatValue() { + return valueFormatter.apply(option().pendingValue()); + } + + /** +