Class ConfigBuilder

java.lang.Object

net.ixdarklord.coolcatcore.api.config.ConfigBuilder

public final class ConfigBuilder
extends Object

Declares a config: its settings, then its groups and values, then build() registers and loads it.

Values are added to the current group; push(String, String...) opens a nested group and pop() closes it, or group(String, Consumer) does both around a block. Each value starts with a typed method (bool(String, boolean), intValue(String, int), list(String, ConfigType, List)...), takes options, and ends with build(), which returns its handle:

ConfigBuilder builder = Config.builder("mymod", ConfigScope.SERVER);
ConfigValue<Integer> maxHomes = builder.intValue("maxHomes", 3).range(0, 64).comment("Homes per player.").build();
builder.push("webhook");
ConfigValue<String> url = builder.string("url", "").serverOnly().build();
builder.pop();
Config config = builder.build();

Method Summary

Modifier and Type	Method	Description
ConfigBuilder	background(net.minecraft.resources.Identifier texture)	A background texture for this config's screen, by its full path (mymod:textures/gui/background.png), keeping the rest of the theme.
EntryBuilder<Boolean>	bool(String key, boolean defaultValue)
Config	build()	Registers the config and loads its file.
<T> EntryBuilder<T>	codec(String key, com.mojang.serialization.Codec<T> codec, T defaultValue)	A value of any codec, edited as JSON.
EntryBuilder<Integer>	color(String key, int defaultValue)	An opaque color, packed as 0xRRGGBB.
EntryBuilder<Integer>	colorWithAlpha(String key, int defaultValue)	A color with alpha, packed as 0xAARRGGBB.
ConfigBuilder	comment(String... lines)	Lines at the top of the file.
NumberEntryBuilder<Double>	doubleValue(String key, double defaultValue)
ConfigBuilder	editPermission(net.minecraft.server.permissions.Permission permission)	Who may change a synced config from a client (the in-game screen): game masters (Permissions.COMMANDS_GAMEMASTER) by default.
ConfigBuilder	effects(net.minecraft.resources.Identifier... effects)	The animated effects of this config's screen, by the ids they're registered under on the client (CoolCatLib: Canvas's ConfigEffects.register), keeping the rest of the theme; none for a still screen.
<E extends Enum<E>> EntryBuilder<E>	enumValue(String key, E defaultValue)
ConfigBuilder	fileName(String fileName)	The file's path without extension, relative to the config folder: <modid>-<name> by default.
NumberEntryBuilder<Float>	floatValue(String key, float defaultValue)
ConfigBuilder	format(ConfigFormat format)	The file's format: ConfigFormats.TOML by default.
ConfigBuilder	group(String key, Consumer<ConfigBuilder> contents)	Declares a nested group's contents in a block.
ConfigBuilder	group(String key, List<String> comment, Consumer<ConfigBuilder> contents)
ConfigBuilder	hotReload(boolean hotReload)	Whether edits to the file while the game runs are loaded automatically; on by default.
EntryBuilder<net.minecraft.resources.Identifier>	identifier(String key, net.minecraft.resources.Identifier defaultValue)
EntryBuilder<net.minecraft.resources.Identifier>	identifier(String key, net.minecraft.resources.Identifier defaultValue, net.minecraft.resources.ResourceKey<? extends net.minecraft.core.Registry<?>> registry)	An id suggested from a built-in registry, like Registries.BLOCK.
NumberEntryBuilder<Integer>	intValue(String key, int defaultValue)
<E> ListEntryBuilder<E>	list(String key, ConfigType<E> elementType, List<E> defaultValue)
NumberEntryBuilder<Long>	longValue(String key, long defaultValue)
ConfigBuilder	migration(int fromVersion, ConfigMigration migration)	Upgrades files of version fromVersion to fromVersion + 1.
ConfigBuilder	name(String name)	The config's name, the path of its id (mymod:<name>); the scope's name by default.
ConfigBuilder	pop()	Closes the group opened last.
ConfigBuilder	preset(String name, Consumer<ConfigPreset.Builder> values)	A named set of values, translated as config.<modid>.<config>.preset.<name>.
ConfigBuilder	preset(String name, @Nullable net.minecraft.network.chat.Component displayName, Consumer<ConfigPreset.Builder> values)
ConfigBuilder	push(String key, String... comment)	Opens a nested group; values and groups go into it until pop().
StringEntryBuilder	string(String key, String defaultValue)
ListEntryBuilder<String>	stringList(String key, List<String> defaultValue)
ConfigBuilder	theme(ConfigTheme theme)	How this config's screen looks; the mod's theme (ConfigTheme.setForMod(String, ConfigTheme)) by default.
<T> EntryBuilder<T>	value(String key, ConfigType<T> type, T defaultValue)	A value of any type, including a mod's own ConfigType.
ConfigBuilder	version(int version)	The file version; files of older versions go through the migration(int, ConfigMigration)s.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

name

public ConfigBuilder name(String name)

The config's name, the path of its id (mymod:<name>); the scope's name by default.

fileName

public ConfigBuilder fileName(String fileName)

The file's path without extension, relative to the config folder: <modid>-<name> by default. May contain folders: "mymod/client".

format

public ConfigBuilder format(ConfigFormat format)

The file's format: ConfigFormats.TOML by default. Changing it later keeps players' values: a file in the other built-in format is converted once (and kept as a .bak).

comment

public ConfigBuilder comment(String... lines)

Lines at the top of the file.

version

public ConfigBuilder version(int version)

The file version; files of older versions go through the migration(int, ConfigMigration)s.

migration

public ConfigBuilder migration(int fromVersion,
 ConfigMigration migration)

Upgrades files of version fromVersion to fromVersion + 1.

editPermission

public ConfigBuilder editPermission(net.minecraft.server.permissions.Permission permission)

Who may change a synced config from a client (the in-game screen): game masters (Permissions.COMMANDS_GAMEMASTER) by default. The host of a singleplayer world always may.

hotReload

public ConfigBuilder hotReload(boolean hotReload)

Whether edits to the file while the game runs are loaded automatically; on by default.

theme

public ConfigBuilder theme(ConfigTheme theme)

How this config's screen looks; the mod's theme (ConfigTheme.setForMod(String, ConfigTheme)) by default.

background

public ConfigBuilder background(net.minecraft.resources.Identifier texture)

A background texture for this config's screen, by its full path (mymod:textures/gui/background.png), keeping the rest of the theme.

effects

public ConfigBuilder effects(net.minecraft.resources.Identifier... effects)

The animated effects of this config's screen, by the ids they're registered under on the client (CoolCatLib: Canvas's ConfigEffects.register), keeping the rest of the theme; none for a still screen. The id is all this needs, so it works in common code.

push

public ConfigBuilder push(String key,
 String... comment)

Opens a nested group; values and groups go into it until pop().

pop

public ConfigBuilder pop()

Closes the group opened last.

group

public ConfigBuilder group(String key,
 Consumer<ConfigBuilder> contents)

Declares a nested group's contents in a block.

group

public ConfigBuilder group(String key,
 List<String> comment,
 Consumer<ConfigBuilder> contents)

bool

public EntryBuilder<Boolean> bool(String key,
 boolean defaultValue)

intValue

public NumberEntryBuilder<Integer> intValue(String key,
 int defaultValue)

longValue

public NumberEntryBuilder<Long> longValue(String key,
 long defaultValue)

floatValue

public NumberEntryBuilder<Float> floatValue(String key,
 float defaultValue)

doubleValue

public NumberEntryBuilder<Double> doubleValue(String key,
 double defaultValue)

string

public StringEntryBuilder string(String key,
 String defaultValue)

enumValue

public <E extends Enum<E>> EntryBuilder<E> enumValue(String key,
 E defaultValue)

color

public EntryBuilder<Integer> color(String key,
 int defaultValue)

An opaque color, packed as 0xRRGGBB.

colorWithAlpha

public EntryBuilder<Integer> colorWithAlpha(String key,
 int defaultValue)

A color with alpha, packed as 0xAARRGGBB.

identifier

public EntryBuilder<net.minecraft.resources.Identifier> identifier(String key,
 net.minecraft.resources.Identifier defaultValue)

identifier

public EntryBuilder<net.minecraft.resources.Identifier> identifier(String key,
 net.minecraft.resources.Identifier defaultValue,
 net.minecraft.resources.ResourceKey<? extends net.minecraft.core.Registry<?>> registry)

An id suggested from a built-in registry, like Registries.BLOCK.

list

public <E> ListEntryBuilder<E> list(String key,
 ConfigType<E> elementType,
 List<E> defaultValue)

stringList

public ListEntryBuilder<String> stringList(String key,
 List<String> defaultValue)

value

public <T> EntryBuilder<T> value(String key,
 ConfigType<T> type,
 T defaultValue)

A value of any type, including a mod's own ConfigType.

codec

public <T> EntryBuilder<T> codec(String key,
 com.mojang.serialization.Codec<T> codec,
 T defaultValue)

A value of any codec, edited as JSON.

preset

public ConfigBuilder preset(String name,
 Consumer<ConfigPreset.Builder> values)

A named set of values, translated as config.<modid>.<config>.preset.<name>. The block runs at build(), so it may refer to values declared after it.

preset

public ConfigBuilder preset(String name,
 @Nullable
 @Nullable net.minecraft.network.chat.Component displayName,
 Consumer<ConfigPreset.Builder> values)

build

public Config build()

Registers the config and loads its file.

Throws:

IllegalStateException - when a group is still open, or the config was already built

IllegalArgumentException - when a config with the same id exists