blob: 68e9986797690bfaf14edabda523cb087e705b6a (
plain)
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
|
package dev.isxander.yacl3.api;
import com.google.common.collect.ImmutableList;
import dev.isxander.yacl3.config.ConfigInstance;
import dev.isxander.yacl3.config.v2.api.ConfigClassHandler;
import dev.isxander.yacl3.gui.YACLScreen;
import dev.isxander.yacl3.impl.YetAnotherConfigLibImpl;
import net.minecraft.client.gui.screens.Screen;
import net.minecraft.network.chat.Component;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import java.util.Collection;
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.
*/
Component title();
/**
* Gets all config categories.
*/
ImmutableList<ConfigCategory> 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<YACLScreen> 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 YetAnotherConfigLibImpl.BuilderImpl();
}
static <T> YetAnotherConfigLib create(ConfigClassHandler<T> configHandler, ConfigBackedBuilder<T> builder) {
return builder.build(configHandler.defaults(), configHandler.instance(), createBuilder().save(configHandler::save)).build();
}
/**
* Creates an instance using a {@link ConfigInstance} which autofills the save() builder method.
* This also takes an easy functional interface that provides defaults and config to help build YACL bindings.
*/
@Deprecated
static <T> YetAnotherConfigLib create(ConfigInstance<T> configInstance, ConfigBackedBuilder<T> builder) {
return builder.build(configInstance.getDefaults(), configInstance.getConfig(), createBuilder().save(configInstance::save)).build();
}
interface Builder {
/**
* Sets title of GUI for Minecraft narration
*
* @see YetAnotherConfigLib#title()
*/
Builder title(@NotNull Component title);
/**
* Adds a new category.
* To create a category you need to use {@link ConfigCategory#createBuilder()}
*
* @see YetAnotherConfigLib#categories()
*/
Builder category(@NotNull ConfigCategory category);
/**
* Adds multiple categories at once.
* To create a category you need to use {@link ConfigCategory#createBuilder()}
*
* @see YetAnotherConfigLib#categories()
*/
Builder categories(@NotNull Collection<? extends ConfigCategory> categories);
/**
* Used to define a save function for when user clicks the Save Changes button
*
* @see YetAnotherConfigLib#saveFunction()
*/
Builder save(@NotNull Runnable saveFunction);
/**
* Defines a consumer that is accepted every time the YACL screen initialises
*
* @see YetAnotherConfigLib#initConsumer()
*/
Builder screenInit(@NotNull Consumer<YACLScreen> initConsumer);
YetAnotherConfigLib build();
}
@FunctionalInterface
interface ConfigBackedBuilder<T> {
YetAnotherConfigLib.Builder build(T defaults, T config, YetAnotherConfigLib.Builder builder);
}
}
|
