From 6f8ef7daaafd71090b2c334c10eadc8dedc738d9 Mon Sep 17 00:00:00 2001 From: xander Date: Thu, 1 Sep 2022 08:57:59 +0100 Subject: GUI Implementation Added groups Added button "option" Added test mod --- src/main/java/dev/isxander/yacl/api/Binding.java | 2 +- .../java/dev/isxander/yacl/api/ButtonOption.java | 75 ++++++++++++++++++++++ .../java/dev/isxander/yacl/api/ConfigCategory.java | 31 +++++++-- src/main/java/dev/isxander/yacl/api/Control.java | 8 ++- .../java/dev/isxander/yacl/api/NameableEnum.java | 7 ++ src/main/java/dev/isxander/yacl/api/Option.java | 21 ++++-- .../java/dev/isxander/yacl/api/OptionGroup.java | 52 +++++++++++++++ .../dev/isxander/yacl/api/YetAnotherConfigLib.java | 31 +++++++-- .../dev/isxander/yacl/api/utils/Dimension.java | 21 ++++++ .../dev/isxander/yacl/api/utils/OptionUtils.java | 28 ++++++++ 10 files changed, 255 insertions(+), 21 deletions(-) create mode 100644 src/main/java/dev/isxander/yacl/api/ButtonOption.java create mode 100644 src/main/java/dev/isxander/yacl/api/NameableEnum.java create mode 100644 src/main/java/dev/isxander/yacl/api/OptionGroup.java create mode 100644 src/main/java/dev/isxander/yacl/api/utils/OptionUtils.java (limited to 'src/main/java/dev/isxander/yacl/api') diff --git a/src/main/java/dev/isxander/yacl/api/Binding.java b/src/main/java/dev/isxander/yacl/api/Binding.java index 67ff822..74120a0 100644 --- a/src/main/java/dev/isxander/yacl/api/Binding.java +++ b/src/main/java/dev/isxander/yacl/api/Binding.java @@ -10,7 +10,7 @@ public interface Binding { T getValue(); - void resetValue(); + T defaultValue(); static Binding of(T def, Supplier getter, Consumer setter) { return new GenericBindingImpl<>(def, getter, setter); diff --git a/src/main/java/dev/isxander/yacl/api/ButtonOption.java b/src/main/java/dev/isxander/yacl/api/ButtonOption.java new file mode 100644 index 0000000..08436b3 --- /dev/null +++ b/src/main/java/dev/isxander/yacl/api/ButtonOption.java @@ -0,0 +1,75 @@ +package dev.isxander.yacl.api; + +import dev.isxander.yacl.impl.ButtonOptionImpl; +import net.minecraft.text.MutableText; +import net.minecraft.text.Text; +import org.apache.commons.lang3.Validate; +import org.jetbrains.annotations.NotNull; + +import java.util.ArrayList; +import java.util.List; +import java.util.function.Function; + +public interface ButtonOption extends Option { + Runnable action(); + + static Builder createBuilder() { + return new Builder(); + } + + class Builder { + private Text name; + private final List tooltipLines = new ArrayList<>(); + private Function> controlGetter; + private Runnable action; + + private Builder() { + + } + + public Builder name(@NotNull Text name) { + Validate.notNull(name, "`name` cannot be null"); + + this.name = name; + return this; + } + + public Builder tooltip(@NotNull Text... tooltips) { + Validate.notEmpty(tooltips, "`tooltips` cannot be empty"); + + tooltipLines.addAll(List.of(tooltips)); + return this; + } + + public Builder action(@NotNull Runnable action) { + Validate.notNull(action, "`action` cannot be null"); + + this.action = action; + return this; + } + + public Builder controller(@NotNull Function> control) { + Validate.notNull(control, "`control` cannot be null"); + + this.controlGetter = control; + return this; + } + + public ButtonOption build() { + Validate.notNull(name, "`name` must not be null when building `Option`"); + Validate.notNull(controlGetter, "`control` must not be null when building `Option`"); + Validate.notNull(action, "`action` must not be null when building `Option`"); + + MutableText concatenatedTooltip = Text.empty(); + boolean first = true; + for (Text line : tooltipLines) { + if (!first) concatenatedTooltip.append("\n"); + first = false; + + concatenatedTooltip.append(line); + } + + return new ButtonOptionImpl(name, concatenatedTooltip, action, controlGetter); + } + } +} diff --git a/src/main/java/dev/isxander/yacl/api/ConfigCategory.java b/src/main/java/dev/isxander/yacl/api/ConfigCategory.java index ee2fbc7..13552d6 100644 --- a/src/main/java/dev/isxander/yacl/api/ConfigCategory.java +++ b/src/main/java/dev/isxander/yacl/api/ConfigCategory.java @@ -1,18 +1,22 @@ package dev.isxander.yacl.api; import com.google.common.collect.ImmutableList; +import dev.isxander.yacl.gui.YACLScreen; import dev.isxander.yacl.impl.ConfigCategoryImpl; +import dev.isxander.yacl.impl.OptionGroupImpl; +import net.minecraft.client.gui.widget.ClickableWidget; import net.minecraft.text.Text; import org.apache.commons.lang3.Validate; import org.jetbrains.annotations.NotNull; import java.util.ArrayList; import java.util.List; +import java.util.function.Function; public interface ConfigCategory { @NotNull Text name(); - @NotNull ImmutableList> options(); + @NotNull ImmutableList groups(); static Builder createBuilder() { return new Builder(); @@ -20,31 +24,44 @@ public interface ConfigCategory { class Builder { private Text name; - private final List> options = new ArrayList<>(); + private final List> rootOptions = new ArrayList<>(); + + private final List groups = new ArrayList<>(); private Builder() { } - public Builder setName(@NotNull Text name) { + public Builder name(@NotNull Text name) { Validate.notNull(name, "`name` cannot be null"); this.name = name; return this; } - public Builder addOption(@NotNull Option option) { + public Builder option(@NotNull Option option) { Validate.notNull(option, "`option` must not be null"); - this.options.add(option); + this.rootOptions.add(option); + return this; + } + + public Builder group(@NotNull OptionGroup group) { + Validate.notNull(group, "`group` must not be null"); + + this.groups.add(group); return this; } public ConfigCategory build() { Validate.notNull(name, "`name` must not be null to build `ConfigCategory`"); - Validate.notEmpty(options, "`at least one option must be added to build `ConfigCategory`"); + Validate.notEmpty(rootOptions, "`at least one option must be added to build `ConfigCategory`"); + + List combinedGroups = new ArrayList<>(); + combinedGroups.add(new OptionGroupImpl(Text.empty(), ImmutableList.copyOf(rootOptions), true)); + combinedGroups.addAll(groups); - return new ConfigCategoryImpl(name, ImmutableList.copyOf(options)); + return new ConfigCategoryImpl(name, ImmutableList.copyOf(combinedGroups)); } } } diff --git a/src/main/java/dev/isxander/yacl/api/Control.java b/src/main/java/dev/isxander/yacl/api/Control.java index 0733c4f..242b2c8 100644 --- a/src/main/java/dev/isxander/yacl/api/Control.java +++ b/src/main/java/dev/isxander/yacl/api/Control.java @@ -1,10 +1,14 @@ package dev.isxander.yacl.api; import dev.isxander.yacl.api.utils.Dimension; -import dev.isxander.yacl.gui.AbstractWidget; +import dev.isxander.yacl.gui.controllers.ControlWidget; +import net.minecraft.client.gui.screen.Screen; +import net.minecraft.text.Text; public interface Control { Option option(); - AbstractWidget provideWidget(Dimension widgetDimension); + Text formatValue(); + + ControlWidget 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 new file mode 100644 index 0000000..12a58c3 --- /dev/null +++ b/src/main/java/dev/isxander/yacl/api/NameableEnum.java @@ -0,0 +1,7 @@ +package dev.isxander.yacl.api; + +import net.minecraft.text.Text; + +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 1c7a8a1..5a98d50 100644 --- a/src/main/java/dev/isxander/yacl/api/Option.java +++ b/src/main/java/dev/isxander/yacl/api/Option.java @@ -10,6 +10,7 @@ import org.jetbrains.annotations.Nullable; import java.util.ArrayList; import java.util.List; import java.util.function.Consumer; +import java.util.function.Function; import java.util.function.Supplier; public interface Option { @@ -23,11 +24,17 @@ public interface Option { boolean changed(); + T pendingValue(); + void requestSet(T value); void applyValue(); - static Builder createBuilder() { + void forgetPendingValue(); + + void requestSetDefault(); + + static Builder createBuilder(Class clazz) { return new Builder<>(); } @@ -36,7 +43,7 @@ public interface Option { private final List tooltipLines = new ArrayList<>(); - private Control control; + private Function, Control> controlGetter; private Binding binding; @@ -58,10 +65,10 @@ public interface Option { return this; } - public Builder controller(@NotNull Control control) { + public Builder controller(@NotNull Function, Control> control) { Validate.notNull(control, "`control` cannot be null"); - this.control = control; + this.controlGetter = control; return this; } @@ -73,7 +80,7 @@ public interface Option { } public Builder binding(@NotNull T def, @NotNull Supplier<@NotNull T> getter, @NotNull Consumer<@NotNull T> setter) { - Validate.notNull(def, "`default` must not be null"); + Validate.notNull(def, "`def` must not be null"); Validate.notNull(getter, "`getter` must not be null"); Validate.notNull(setter, "`setter` must not be null"); @@ -83,7 +90,7 @@ public interface Option { public Option build() { Validate.notNull(name, "`name` must not be null when building `Option`"); - Validate.notNull(control, "`control` must not be null when building `Option`"); + Validate.notNull(controlGetter, "`control` must not be null when building `Option`"); Validate.notNull(binding, "`binding` must not be null when building `Option`"); MutableText concatenatedTooltip = Text.empty(); @@ -95,7 +102,7 @@ public interface Option { concatenatedTooltip.append(line); } - return new OptionImpl<>(name, concatenatedTooltip, control, binding); + return new OptionImpl<>(name, concatenatedTooltip, controlGetter, binding); } } } diff --git a/src/main/java/dev/isxander/yacl/api/OptionGroup.java b/src/main/java/dev/isxander/yacl/api/OptionGroup.java new file mode 100644 index 0000000..bedbc82 --- /dev/null +++ b/src/main/java/dev/isxander/yacl/api/OptionGroup.java @@ -0,0 +1,52 @@ +package dev.isxander.yacl.api; + +import com.google.common.collect.ImmutableList; +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.List; + +public interface OptionGroup { + Text name(); + + @NotNull ImmutableList> options(); + + boolean isRoot(); + + static Builder createBuilder() { + return new Builder(); + } + + class Builder { + private Text name = Text.empty(); + private final List> options = new ArrayList<>(); + + private Builder() { + + } + + public Builder name(@NotNull Text name) { + Validate.notNull(name, "`name` must not be null"); + + this.name = name; + return this; + } + + public Builder option(@NotNull Option option) { + Validate.notNull(option, "`option` must not be null"); + + this.options.add(option); + return this; + } + + public OptionGroup build() { + Validate.notEmpty(options, "`options` must not be empty to build `OptionGroup`"); + + return new OptionGroupImpl(name, ImmutableList.copyOf(options), false); + } + } +} diff --git a/src/main/java/dev/isxander/yacl/api/YetAnotherConfigLib.java b/src/main/java/dev/isxander/yacl/api/YetAnotherConfigLib.java index d7f8416..a598e27 100644 --- a/src/main/java/dev/isxander/yacl/api/YetAnotherConfigLib.java +++ b/src/main/java/dev/isxander/yacl/api/YetAnotherConfigLib.java @@ -1,14 +1,17 @@ package dev.isxander.yacl.api; import com.google.common.collect.ImmutableList; +import dev.isxander.yacl.gui.YACLScreen; import dev.isxander.yacl.impl.YetAnotherConfigLibImpl; import net.minecraft.client.gui.screen.Screen; 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; +import java.util.function.Consumer; public interface YetAnotherConfigLib { @@ -16,7 +19,11 @@ public interface YetAnotherConfigLib { ImmutableList categories(); - Screen generateScreen(); + Runnable saveFunction(); + + Consumer initConsumer(); + + Screen generateScreen(@Nullable Screen parent); static Builder createBuilder(Text title) { return new Builder(title); @@ -25,31 +32,47 @@ public interface YetAnotherConfigLib { class Builder { private Text title; private final List categories = new ArrayList<>(); + private Runnable saveFunction = () -> {}; + private Consumer initConsumer = screen -> {}; private Builder(@NotNull Text title) { Validate.notNull(title, "`title` cannot be null"); this.title = title; } - public Builder setTitle(@NotNull Text title) { + public Builder title(@NotNull Text title) { Validate.notNull(title, "`title` cannot be null"); this.title = title; return this; } - public Builder addCategory(@NotNull ConfigCategory category) { + public Builder category(@NotNull ConfigCategory category) { Validate.notNull(category, "`category` cannot be null"); this.categories.add(category); return this; } + public Builder save(@NotNull Runnable saveFunction) { + Validate.notNull(saveFunction, "`saveFunction` cannot be null"); + + this.saveFunction = saveFunction; + return this; + } + + public Builder screenInit(@NotNull Consumer initConsumer) { + Validate.notNull(initConsumer, "`initConsumer` cannot be null"); + + this.initConsumer = initConsumer; + return this; + } + public YetAnotherConfigLib build() { Validate.notNull(title, "`title must not be null to build `YetAnotherConfigLib`"); Validate.notEmpty(categories, "`categories` must not be empty to build `YetAnotherConfigLib`"); - return new YetAnotherConfigLibImpl(title, ImmutableList.copyOf(categories)); + return new YetAnotherConfigLibImpl(title, ImmutableList.copyOf(categories), saveFunction, initConsumer); } } } diff --git a/src/main/java/dev/isxander/yacl/api/utils/Dimension.java b/src/main/java/dev/isxander/yacl/api/utils/Dimension.java index cf7127a..69958b1 100644 --- a/src/main/java/dev/isxander/yacl/api/utils/Dimension.java +++ b/src/main/java/dev/isxander/yacl/api/utils/Dimension.java @@ -12,8 +12,29 @@ public interface Dimension { T xLimit(); T yLimit(); + T centerX(); + T centerY(); + boolean isPointInside(T x, T y); + Dimension clone(); + + Dimension setX(T x); + Dimension setY(T y); + Dimension setWidth(T width); + Dimension setHeight(T height); + + Dimension withX(T x); + Dimension withY(T y); + Dimension withWidth(T width); + Dimension withHeight(T height); + + Dimension move(T x, T y); + Dimension expand(T width, T height); + + Dimension moved(T x, T y); + Dimension expanded(T width, T height); + static Dimension ofInt(int x, int y, int width, int height) { return new DimensionIntegerImpl(x, y, width, height); } diff --git a/src/main/java/dev/isxander/yacl/api/utils/OptionUtils.java b/src/main/java/dev/isxander/yacl/api/utils/OptionUtils.java new file mode 100644 index 0000000..ed51683 --- /dev/null +++ b/src/main/java/dev/isxander/yacl/api/utils/OptionUtils.java @@ -0,0 +1,28 @@ +package dev.isxander.yacl.api.utils; + +import dev.isxander.yacl.api.ConfigCategory; +import dev.isxander.yacl.api.Option; +import dev.isxander.yacl.api.OptionGroup; +import dev.isxander.yacl.api.YetAnotherConfigLib; + +import java.util.function.Consumer; +import java.util.function.Function; + +public class OptionUtils { + 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; + } + } + } + } + + public static void forEachOptions(YetAnotherConfigLib yacl, Consumer> consumer) { + consumeOptions(yacl, (opt) -> { + consumer.accept(opt); + return true; + }); + } +} -- cgit