1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
|
package dev.isxander.yacl3.api;
import com.google.common.collect.ImmutableList;
import dev.isxander.yacl3.impl.ConfigCategoryImpl;
import net.minecraft.network.chat.Component;
import org.jetbrains.annotations.NotNull;
import java.util.Collection;
import java.util.function.Supplier;
/**
* 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 Component name();
/**
* Gets every {@link OptionGroup} in this category.
*/
@NotNull ImmutableList<OptionGroup> groups();
/**
* Tooltip (or description) of the category.
* Rendered on hover.
*/
@NotNull Component tooltip();
/**
* Creates a builder to construct a {@link ConfigCategory}
*/
static Builder createBuilder() {
return new ConfigCategoryImpl.BuilderImpl();
}
interface Builder extends OptionAddable {
/**
* Sets name of the category
*
* @see ConfigCategory#name()
*/
Builder name(@NotNull Component name);
/**
* 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()}
*
* @see ConfigCategory#groups()
* @see OptionGroup#isRoot()
*/
@Override
Builder option(@NotNull Option<?> option);
/**
* 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()}
*
* @param optionSupplier to be called to initialise the option. called immediately
* @return this
*/
@Override
default Builder option(@NotNull Supplier<@NotNull Option<?>> optionSupplier) {
OptionAddable.super.option(optionSupplier);
return this;
}
/**
* Adds an option to the root group of the category if a condition is met.
* To add to another group, use {@link Builder#group(OptionGroup)}.
* To construct an option, use {@link Option#createBuilder()}
*
* @param condition only if true is the option added
* @return this
*/
@Override
default Builder optionIf(boolean condition, @NotNull Option<?> option) {
OptionAddable.super.optionIf(condition, option);
return this;
}
/**
* Adds an option to the root group of the category if a condition is met.
* To add to another group, use {@link Builder#group(OptionGroup)}.
* To construct an option, use {@link Option#createBuilder()}
*
* @param condition only if true is the option added
* @param optionSupplier to be called to initialise the option. called immediately only if condition is true
* @return this
*/
@Override
default Builder optionIf(boolean condition, @NotNull Supplier<@NotNull Option<?>> optionSupplier) {
OptionAddable.super.optionIf(condition, optionSupplier);
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()}
*
* @see ConfigCategory#groups()
* @see OptionGroup#isRoot()
*/
@Override
Builder options(@NotNull Collection<? extends Option<?>> options);
/**
* 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()}
*/
Builder group(@NotNull OptionGroup group);
/**
* 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()}
*/
Builder groups(@NotNull Collection<OptionGroup> groups);
/**
* Fetches the builder for the root group of the category.
* This is the group that has no header and options are added through {@link Builder#option(Option)}.
* In its default implementation, this builder is severely limited and a lot of methods are unsupported.
*/
OptionGroup.Builder rootGroupBuilder();
/**
* Sets the tooltip to be used by the category.
* 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()}.
*/
Builder tooltip(@NotNull Component... tooltips);
ConfigCategory build();
}
}
|
