Package net.neoforged.neoforge.common

Class ModConfigSpec.Builder

java.lang.Object

net.neoforged.neoforge.common.ModConfigSpec.Builder

Enclosing class:

ModConfigSpec

public static class ModConfigSpec.Builder
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
private ModConfigSpec.BuilderContext	context
private final List<String>	currentPath
private final Map<List<String>,String>	levelComments
private final Map<List<String>,String>	levelTranslationKeys
private final com.electronwill.nightconfig.core.Config	spec
private final List<ModConfigSpec.ConfigValue<?>>	values

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ModConfigSpec	build()
ModConfigSpec.Builder	comment(String comment)
ModConfigSpec.Builder	comment(String... comment)
<T> org.apache.commons.lang3.tuple.Pair<T,ModConfigSpec>	configure(Function<ModConfigSpec.Builder,T> consumer)
ModConfigSpec.BooleanValue	define(String path, boolean defaultValue)
ModConfigSpec.BooleanValue	define(String path, Supplier<Boolean> defaultSupplier)
<T> ModConfigSpec.ConfigValue<T>	define(String path, Supplier<T> defaultSupplier, Predicate<Object> validator)
<T> ModConfigSpec.ConfigValue<T>	define(String path, T defaultValue)
<T> ModConfigSpec.ConfigValue<T>	define(String path, T defaultValue, Predicate<Object> validator)
ModConfigSpec.BooleanValue	define(List<String> path, boolean defaultValue)
ModConfigSpec.BooleanValue	define(List<String> path, Supplier<Boolean> defaultSupplier)
<T> ModConfigSpec.ConfigValue<T>	define(List<String> path, Supplier<T> defaultSupplier, Predicate<Object> validator)
<T> ModConfigSpec.ConfigValue<T>	define(List<String> path, Supplier<T> defaultSupplier, Predicate<Object> validator, Class<?> clazz)
<T> ModConfigSpec.ConfigValue<T>	define(List<String> path, ModConfigSpec.ValueSpec value, Supplier<T> defaultSupplier)
<T> ModConfigSpec.ConfigValue<T>	define(List<String> path, T defaultValue)
<T> ModConfigSpec.ConfigValue<T>	define(List<String> path, T defaultValue, Predicate<Object> validator)
<V extends Enum<V>> ModConfigSpec.EnumValue<V>	defineEnum(String path, Supplier<V> defaultSupplier, com.electronwill.nightconfig.core.EnumGetMethod converter, Predicate<Object> validator, Class<V> clazz)
<V extends Enum<V>> ModConfigSpec.EnumValue<V>	defineEnum(String path, Supplier<V> defaultSupplier, Predicate<Object> validator, Class<V> clazz)
<V extends Enum<V>> ModConfigSpec.EnumValue<V>	defineEnum(String path, V defaultValue)
<V extends Enum<V>> ModConfigSpec.EnumValue<V>	defineEnum(String path, V defaultValue, com.electronwill.nightconfig.core.EnumGetMethod converter)
<V extends Enum<V>> ModConfigSpec.EnumValue<V>	defineEnum(String path, V defaultValue, com.electronwill.nightconfig.core.EnumGetMethod converter, Collection<V> acceptableValues)
<V extends Enum<V>> ModConfigSpec.EnumValue<V>	defineEnum(String path, V defaultValue, com.electronwill.nightconfig.core.EnumGetMethod converter, Predicate<Object> validator)
<V extends Enum<V>> ModConfigSpec.EnumValue<V>	defineEnum(String path, V defaultValue, com.electronwill.nightconfig.core.EnumGetMethod converter, V... acceptableValues)
<V extends Enum<V>> ModConfigSpec.EnumValue<V>	defineEnum(String path, V defaultValue, Collection<V> acceptableValues)
<V extends Enum<V>> ModConfigSpec.EnumValue<V>	defineEnum(String path, V defaultValue, Predicate<Object> validator)
<V extends Enum<V>> ModConfigSpec.EnumValue<V>	defineEnum(String path, V defaultValue, V... acceptableValues)
<V extends Enum<V>> ModConfigSpec.EnumValue<V>	defineEnum(List<String> path, Supplier<V> defaultSupplier, com.electronwill.nightconfig.core.EnumGetMethod converter, Predicate<Object> validator, Class<V> clazz)
<V extends Enum<V>> ModConfigSpec.EnumValue<V>	defineEnum(List<String> path, Supplier<V> defaultSupplier, Predicate<Object> validator, Class<V> clazz)
<V extends Enum<V>> ModConfigSpec.EnumValue<V>	defineEnum(List<String> path, V defaultValue)
<V extends Enum<V>> ModConfigSpec.EnumValue<V>	defineEnum(List<String> path, V defaultValue, com.electronwill.nightconfig.core.EnumGetMethod converter)
<V extends Enum<V>> ModConfigSpec.EnumValue<V>	defineEnum(List<String> path, V defaultValue, com.electronwill.nightconfig.core.EnumGetMethod converter, Collection<V> acceptableValues)
<V extends Enum<V>> ModConfigSpec.EnumValue<V>	defineEnum(List<String> path, V defaultValue, com.electronwill.nightconfig.core.EnumGetMethod converter, Predicate<Object> validator)
<V extends Enum<V>> ModConfigSpec.EnumValue<V>	defineEnum(List<String> path, V defaultValue, com.electronwill.nightconfig.core.EnumGetMethod converter, V... acceptableValues)
<V extends Enum<V>> ModConfigSpec.EnumValue<V>	defineEnum(List<String> path, V defaultValue, Collection<V> acceptableValues)
<V extends Enum<V>> ModConfigSpec.EnumValue<V>	defineEnum(List<String> path, V defaultValue, Predicate<Object> validator)
<V extends Enum<V>> ModConfigSpec.EnumValue<V>	defineEnum(List<String> path, V defaultValue, V... acceptableValues)
<T> ModConfigSpec.ConfigValue<T>	defineInList(String path, Supplier<T> defaultSupplier, Collection<? extends T> acceptableValues)
<T> ModConfigSpec.ConfigValue<T>	defineInList(String path, T defaultValue, Collection<? extends T> acceptableValues)
<T> ModConfigSpec.ConfigValue<T>	defineInList(List<String> path, Supplier<T> defaultSupplier, Collection<? extends T> acceptableValues)
<T> ModConfigSpec.ConfigValue<T>	defineInList(List<String> path, T defaultValue, Collection<? extends T> acceptableValues)
ModConfigSpec.DoubleValue	defineInRange(String path, double defaultValue, double min, double max)
ModConfigSpec.IntValue	defineInRange(String path, int defaultValue, int min, int max)
ModConfigSpec.LongValue	defineInRange(String path, long defaultValue, long min, long max)
ModConfigSpec.DoubleValue	defineInRange(String path, Supplier<Double> defaultSupplier, double min, double max)
ModConfigSpec.IntValue	defineInRange(String path, Supplier<Integer> defaultSupplier, int min, int max)
ModConfigSpec.LongValue	defineInRange(String path, Supplier<Long> defaultSupplier, long min, long max)
<V extends Comparable<? super V>> ModConfigSpec.ConfigValue<V>	defineInRange(String path, Supplier<V> defaultSupplier, V min, V max, Class<V> clazz)
<V extends Comparable<? super V>> ModConfigSpec.ConfigValue<V>	defineInRange(String path, V defaultValue, V min, V max, Class<V> clazz)
ModConfigSpec.DoubleValue	defineInRange(List<String> path, double defaultValue, double min, double max)
ModConfigSpec.IntValue	defineInRange(List<String> path, int defaultValue, int min, int max)
ModConfigSpec.LongValue	defineInRange(List<String> path, long defaultValue, long min, long max)
ModConfigSpec.DoubleValue	defineInRange(List<String> path, Supplier<Double> defaultSupplier, double min, double max)
ModConfigSpec.IntValue	defineInRange(List<String> path, Supplier<Integer> defaultSupplier, int min, int max)
ModConfigSpec.LongValue	defineInRange(List<String> path, Supplier<Long> defaultSupplier, long min, long max)
<V extends Comparable<? super V>> ModConfigSpec.ConfigValue<V>	defineInRange(List<String> path, Supplier<V> defaultSupplier, V min, V max, Class<V> clazz)
<V extends Comparable<? super V>> ModConfigSpec.ConfigValue<V>	defineInRange(List<String> path, V defaultValue, V min, V max, Class<V> clazz)
<T> ModConfigSpec.ConfigValue<List<? extends T>>	defineList(String path, Supplier<List<? extends T>> defaultSupplier, Predicate<Object> elementValidator)	Deprecated. Use defineList(String, Supplier, Supplier, Predicate)
<T> ModConfigSpec.ConfigValue<List<? extends T>>	defineList(String path, Supplier<List<? extends T>> defaultSupplier, Supplier<T> newElementSupplier, Predicate<Object> elementValidator)	See defineList(List, Supplier, Supplier, Predicate) for details.
<T> ModConfigSpec.ConfigValue<List<? extends T>>	defineList(String path, List<? extends T> defaultValue, Predicate<Object> elementValidator)	Deprecated. Use defineList(String, List, Supplier, Predicate)
<T> ModConfigSpec.ConfigValue<List<? extends T>>	defineList(String path, List<? extends T> defaultValue, Supplier<T> newElementSupplier, Predicate<Object> elementValidator)	See defineList(List, Supplier, Supplier, Predicate) for details.
<T> ModConfigSpec.ConfigValue<List<? extends T>>	defineList(List<String> path, Supplier<List<? extends T>> defaultSupplier, @Nullable Supplier<T> newElementSupplier, Predicate<Object> elementValidator, @Nullable ModConfigSpec.Range<Integer> sizeRange)	Build a new config value that holds a List.
<T> ModConfigSpec.ConfigValue<List<? extends T>>	defineList(List<String> path, Supplier<List<? extends T>> defaultSupplier, Predicate<Object> elementValidator)	Deprecated. Use defineList(List, Supplier, Supplier, Predicate)
<T> ModConfigSpec.ConfigValue<List<? extends T>>	defineList(List<String> path, Supplier<List<? extends T>> defaultSupplier, Supplier<T> newElementSupplier, Predicate<Object> elementValidator)	Build a new config value that holds a List.
<T> ModConfigSpec.ConfigValue<List<? extends T>>	defineList(List<String> path, List<? extends T> defaultValue, Predicate<Object> elementValidator)	Deprecated. Use defineList(List, List, Supplier, Predicate)
<T> ModConfigSpec.ConfigValue<List<? extends T>>	defineList(List<String> path, List<? extends T> defaultValue, Supplier<T> newElementSupplier, Predicate<Object> elementValidator)	See defineList(List, Supplier, Supplier, Predicate) for details.
<T> ModConfigSpec.ConfigValue<List<? extends T>>	defineListAllowEmpty(String path, Supplier<List<? extends T>> defaultSupplier, Predicate<Object> elementValidator)	Deprecated. Use defineListAllowEmpty(String, Supplier, Supplier, Predicate)
<T> ModConfigSpec.ConfigValue<List<? extends T>>	defineListAllowEmpty(String path, Supplier<List<? extends T>> defaultSupplier, Supplier<T> newElementSupplier, Predicate<Object> elementValidator)	See defineListAllowEmpty(List, Supplier, Supplier, Predicate) for details.
<T> ModConfigSpec.ConfigValue<List<? extends T>>	defineListAllowEmpty(String path, List<? extends T> defaultValue, Predicate<Object> elementValidator)	Deprecated. Use defineListAllowEmpty(String, List, Supplier, Predicate)
<T> ModConfigSpec.ConfigValue<List<? extends T>>	defineListAllowEmpty(String path, List<? extends T> defaultValue, Supplier<T> newElementSupplier, Predicate<Object> elementValidator)	See defineListAllowEmpty(List, Supplier, Supplier, Predicate) for details.
<T> ModConfigSpec.ConfigValue<List<? extends T>>	defineListAllowEmpty(List<String> path, Supplier<List<? extends T>> defaultSupplier, Predicate<Object> elementValidator)	Deprecated. Use defineListAllowEmpty(List, Supplier, Supplier, Predicate)
<T> ModConfigSpec.ConfigValue<List<? extends T>>	defineListAllowEmpty(List<String> path, Supplier<List<? extends T>> defaultSupplier, Supplier<T> newElementSupplier, Predicate<Object> elementValidator)	Build a new config value that holds a List.
<T> ModConfigSpec.ConfigValue<List<? extends T>>	defineListAllowEmpty(List<String> path, List<? extends T> defaultValue, Predicate<Object> elementValidator)	Deprecated. Use defineListAllowEmpty(List, List, Supplier, Predicate)
<T> ModConfigSpec.ConfigValue<List<? extends T>>	defineListAllowEmpty(List<String> path, List<? extends T> defaultValue, Supplier<T> newElementSupplier, Predicate<Object> elementValidator)	See defineListAllowEmpty(List, Supplier, Supplier, Predicate) for details.
ModConfigSpec.Builder	gameRestart()	Config values marked as needing a game restart will never reset their cached value.
ModConfigSpec.Builder	pop()
ModConfigSpec.Builder	pop(int count)
ModConfigSpec.Builder	push(String path)
ModConfigSpec.Builder	push(List<String> path)
ModConfigSpec.Builder	translation(String translationKey)
ModConfigSpec.Builder	worldRestart()	Config values marked as needing a world restart will not reset their cached value until they are unloaded (i.e. when a world is closed).

Methods inherited from class java.lang.Object

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

Field Details

spec

private final com.electronwill.nightconfig.core.Config spec

context

private ModConfigSpec.BuilderContext context

levelComments

private final Map<List<String>,String> levelComments

levelTranslationKeys

private final Map<List<String>,String> levelTranslationKeys

currentPath

private final List<String> currentPath

values

private final List<ModConfigSpec.ConfigValue<?>> values

Constructor Details

Builder

public Builder()

Method Details

define

public <T> ModConfigSpec.ConfigValue<T> define(String path,
 T defaultValue)

define

public <T> ModConfigSpec.ConfigValue<T> define(List<String> path,
 T defaultValue)

define

public <T> ModConfigSpec.ConfigValue<T> define(String path,
 T defaultValue,
 Predicate<Object> validator)

define

public <T> ModConfigSpec.ConfigValue<T> define(List<String> path,
 T defaultValue,
 Predicate<Object> validator)

define

public <T> ModConfigSpec.ConfigValue<T> define(String path,
 Supplier<T> defaultSupplier,
 Predicate<Object> validator)

define

public <T> ModConfigSpec.ConfigValue<T> define(List<String> path,
 Supplier<T> defaultSupplier,
 Predicate<Object> validator)

define

public <T> ModConfigSpec.ConfigValue<T> define(List<String> path,
 Supplier<T> defaultSupplier,
 Predicate<Object> validator,
 Class<?> clazz)

define

public <T> ModConfigSpec.ConfigValue<T> define(List<String> path,
 ModConfigSpec.ValueSpec value,
 Supplier<T> defaultSupplier)

defineInRange

public <V extends Comparable<? super V>>
ModConfigSpec.ConfigValue<V> defineInRange(String path,
 V defaultValue,
 V min,
 V max,
 Class<V> clazz)

defineInRange

public <V extends Comparable<? super V>>
ModConfigSpec.ConfigValue<V> defineInRange(List<String> path,
 V defaultValue,
 V min,
 V max,
 Class<V> clazz)

defineInRange

public <V extends Comparable<? super V>>
ModConfigSpec.ConfigValue<V> defineInRange(String path,
 Supplier<V> defaultSupplier,
 V min,
 V max,
 Class<V> clazz)

defineInRange

public <V extends Comparable<? super V>>
ModConfigSpec.ConfigValue<V> defineInRange(List<String> path,
 Supplier<V> defaultSupplier,
 V min,
 V max,
 Class<V> clazz)

defineInList

public <T> ModConfigSpec.ConfigValue<T> defineInList(String path,
 T defaultValue,
 Collection<? extends T> acceptableValues)

defineInList

public <T> ModConfigSpec.ConfigValue<T> defineInList(String path,
 Supplier<T> defaultSupplier,
 Collection<? extends T> acceptableValues)

defineInList

public <T> ModConfigSpec.ConfigValue<T> defineInList(List<String> path,
 T defaultValue,
 Collection<? extends T> acceptableValues)

defineInList

public <T> ModConfigSpec.ConfigValue<T> defineInList(List<String> path,
 Supplier<T> defaultSupplier,
 Collection<? extends T> acceptableValues)

defineList

@Deprecated
public <T>
ModConfigSpec.ConfigValue<List<? extends T>> defineList(String path,
 List<? extends T> defaultValue,
 Predicate<Object> elementValidator)

Deprecated.

Use defineList(String, List, Supplier, Predicate)

See defineList(List, Supplier, Supplier, Predicate) for details.

This variant takes its key as a string and splits it on ".".
This variant takes its default value directly and wraps it in a supplier.
This variant has no supplier for new elements, so no new elements can be added in the config UI.

defineList

public <T>
ModConfigSpec.ConfigValue<List<? extends T>> defineList(String path,
 List<? extends T> defaultValue,
 Supplier<T> newElementSupplier,
 Predicate<Object> elementValidator)

See defineList(List, Supplier, Supplier, Predicate) for details.

This variant takes its key as a string and splits it on ".".
This variant takes its default value directly and wraps it in a supplier.

defineList

@Deprecated
public <T>
ModConfigSpec.ConfigValue<List<? extends T>> defineList(String path,
 Supplier<List<? extends T>> defaultSupplier,
 Predicate<Object> elementValidator)

Deprecated.

Use defineList(String, Supplier, Supplier, Predicate)

See defineList(List, Supplier, Supplier, Predicate) for details.

This variant takes its key as a string and splits it on ".".
This variant has no supplier for new elements, so no new elements can be added in the config UI.

defineList

public <T>
ModConfigSpec.ConfigValue<List<? extends T>> defineList(String path,
 Supplier<List<? extends T>> defaultSupplier,
 Supplier<T> newElementSupplier,
 Predicate<Object> elementValidator)

See defineList(List, Supplier, Supplier, Predicate) for details.

This variant takes its key as a string and splits it on ".".

defineList

@Deprecated
public <T>
ModConfigSpec.ConfigValue<List<? extends T>> defineList(List<String> path,
 List<? extends T> defaultValue,
 Predicate<Object> elementValidator)

Deprecated.

Use defineList(List, List, Supplier, Predicate)

See defineList(List, Supplier, Supplier, Predicate) for details.

This variant takes its default value directly and wraps it in a supplier.
This variant has no supplier for new elements, so no new elements can be added in the config UI.

defineList

public <T>
ModConfigSpec.ConfigValue<List<? extends T>> defineList(List<String> path,
 List<? extends T> defaultValue,
 Supplier<T> newElementSupplier,
 Predicate<Object> elementValidator)

See defineList(List, Supplier, Supplier, Predicate) for details.

This variant takes its default value directly and wraps it in a supplier.

defineList

@Deprecated
public <T>
ModConfigSpec.ConfigValue<List<? extends T>> defineList(List<String> path,
 Supplier<List<? extends T>> defaultSupplier,
 Predicate<Object> elementValidator)

Deprecated.

Use defineList(List, Supplier, Supplier, Predicate)

See defineList(List, Supplier, Supplier, Predicate) for details.

This variant has no supplier for new elements, so no new elements can be added in the config UI.

defineList

public <T>
ModConfigSpec.ConfigValue<List<? extends T>> defineList(List<String> path,
 Supplier<List<? extends T>> defaultSupplier,
 Supplier<T> newElementSupplier,
 Predicate<Object> elementValidator)

Build a new config value that holds a List.

This list cannot be empty. See also defineList(List, Supplier, Supplier, Predicate, Range) for more control over the list size.

Type Parameters:

T - The class of element of the list. Directly supported are String, Boolean, Integer, Long and Double. Other classes will be saved using their string representation and will be read back from the config file as strings.

Parameters:

path - The key for the config value in list form, i.e. pre-split into section and key.

defaultSupplier - A Supplier for the default value of the list. This will be used if the config file doesn't exist or if it reads as invalid.

newElementSupplier - A Supplier for new elements to be added to the list. This is only used in the UI when the user presses the "add" button. The supplied value doesn't have to validate as correct, but it should provide a good starting point for the user to make it correct. If this parameter is null, there will be no "add" button in the UI (if the default UI is used).

elementValidator - A Predicate to verify if a list element is valid. Elements that are read from the config file are removed from the list if the validator rejects them.

Returns:

A ModConfigSpec.ConfigValue object that can be used to access the config value and that will live-update if the value changed, i.e. because the config file was updated or the config UI was used.

defineListAllowEmpty

@Deprecated
public <T>
ModConfigSpec.ConfigValue<List<? extends T>> defineListAllowEmpty(String path,
 List<? extends T> defaultValue,
 Predicate<Object> elementValidator)

Deprecated.

Use defineListAllowEmpty(String, List, Supplier, Predicate)

See defineListAllowEmpty(List, Supplier, Supplier, Predicate) for details.

This variant takes its key as a string and splits it on ".".
This variant takes its default value directly and wraps it in a supplier.
This variant has no supplier for new elements, so no new elements can be added in the config UI.

defineListAllowEmpty

public <T>
ModConfigSpec.ConfigValue<List<? extends T>> defineListAllowEmpty(String path,
 List<? extends T> defaultValue,
 Supplier<T> newElementSupplier,
 Predicate<Object> elementValidator)

See defineListAllowEmpty(List, Supplier, Supplier, Predicate) for details.

This variant takes its key as a string and splits it on ".".
This variant takes its default value directly and wraps it in a supplier.

defineListAllowEmpty

@Deprecated
public <T>
ModConfigSpec.ConfigValue<List<? extends T>> defineListAllowEmpty(String path,
 Supplier<List<? extends T>> defaultSupplier,
 Predicate<Object> elementValidator)

Deprecated.

Use defineListAllowEmpty(String, Supplier, Supplier, Predicate)

See defineListAllowEmpty(List, Supplier, Supplier, Predicate) for details.

This variant takes its key as a string and splits it on ".".
This variant has no supplier for new elements, so no new elements can be added in the config UI.

defineListAllowEmpty

public <T>
ModConfigSpec.ConfigValue<List<? extends T>> defineListAllowEmpty(String path,
 Supplier<List<? extends T>> defaultSupplier,
 Supplier<T> newElementSupplier,
 Predicate<Object> elementValidator)

See defineListAllowEmpty(List, Supplier, Supplier, Predicate) for details.

This variant takes its key as a string and splits it on ".".

defineListAllowEmpty

@Deprecated
public <T>
ModConfigSpec.ConfigValue<List<? extends T>> defineListAllowEmpty(List<String> path,
 List<? extends T> defaultValue,
 Predicate<Object> elementValidator)

Deprecated.

Use defineListAllowEmpty(List, List, Supplier, Predicate)

See defineListAllowEmpty(List, Supplier, Supplier, Predicate) for details.

This variant takes its default value directly and wraps it in a supplier.
This variant has no supplier for new elements, so no new elements can be added in the config UI.

defineListAllowEmpty

public <T>
ModConfigSpec.ConfigValue<List<? extends T>> defineListAllowEmpty(List<String> path,
 List<? extends T> defaultValue,
 Supplier<T> newElementSupplier,
 Predicate<Object> elementValidator)

See defineListAllowEmpty(List, Supplier, Supplier, Predicate) for details.

This variant takes its default value directly and wraps it in a supplier.

defineListAllowEmpty

@Deprecated
public <T>
ModConfigSpec.ConfigValue<List<? extends T>> defineListAllowEmpty(List<String> path,
 Supplier<List<? extends T>> defaultSupplier,
 Predicate<Object> elementValidator)

Deprecated.

Use defineListAllowEmpty(List, Supplier, Supplier, Predicate)

See defineListAllowEmpty(List, Supplier, Supplier, Predicate) for details.

This variant has no supplier for new elements, so no new elements can be added in the config UI.

defineListAllowEmpty

public <T>
ModConfigSpec.ConfigValue<List<? extends T>> defineListAllowEmpty(List<String> path,
 Supplier<List<? extends T>> defaultSupplier,
 Supplier<T> newElementSupplier,
 Predicate<Object> elementValidator)

Build a new config value that holds a List.

This list can be empty. See also defineList(List, Supplier, Supplier, Predicate, Range) for more control over the list size.

Type Parameters:

T - The class of element of the list. Directly supported are String, Boolean, Integer, Long and Double. Other classes will be saved using their string representation and will be read back from the config file as strings.

Parameters:

path - The key for the config value in list form, i.e. pre-split into section and key.

defaultSupplier - A Supplier for the default value of the list. This will be used if the config file doesn't exist or if it reads as invalid.

newElementSupplier - A Supplier for new elements to be added to the list. This is only used in the UI when the user presses the "add" button. The supplied value doesn't have to validate as correct, but it should provide a good starting point for the user to make it correct. If this parameter is null, there will be no "add" button in the UI (if the default UI is used).

elementValidator - A Predicate to verify if a list element is valid. Elements that are read from the config file are removed from the list if the validator rejects them.

Returns:

A ModConfigSpec.ConfigValue object that can be used to access the config value and that will live-update if the value changed, i.e. because the config file was updated or the config UI was used.

defineList

public <T>
ModConfigSpec.ConfigValue<List<? extends T>> defineList(List<String> path,
 Supplier<List<? extends T>> defaultSupplier,
 @Nullable
 @Nullable Supplier<T> newElementSupplier,
 Predicate<Object> elementValidator,
 @Nullable
 @Nullable ModConfigSpec.Range<Integer> sizeRange)

Build a new config value that holds a List.

Type Parameters:

T - The class of element of the list. Directly supported are String, Boolean, Integer, Long and Double. Other classes will be saved using their string representation and will be read back from the config file as strings.

Parameters:

path - The key for the config value in list form, i.e. pre-split into section and key.

defaultSupplier - A Supplier for the default value of the list. This will be used if the config file doesn't exist or if it reads as invalid.

newElementSupplier - A Supplier for new elements to be added to the list. This is only used in the UI when the user presses the "add" button. The supplied value doesn't have to validate as correct, but it should provide a good starting point for the user to make it correct. If this parameter is null, there will be no "add" button in the UI (if the default UI is used).

elementValidator - A Predicate to verify if a list element is valid. Elements that are read from the config file are removed from the list if the validator rejects them.

sizeRange - A ModConfigSpec.Range defining the valid length of the list. Lists read from the config file that don't validate with this Range will be replaced with the default. When null, the list size is unbounded.

Returns:

A ModConfigSpec.ConfigValue object that can be used to access the config value and that will live-update if the value changed, i.e. because the config file was updated or the config UI was used.

defineEnum

public <V extends Enum<V>>
ModConfigSpec.EnumValue<V> defineEnum(String path,
 V defaultValue)

defineEnum

public <V extends Enum<V>>
ModConfigSpec.EnumValue<V> defineEnum(String path,
 V defaultValue,
 com.electronwill.nightconfig.core.EnumGetMethod converter)

defineEnum

public <V extends Enum<V>>
ModConfigSpec.EnumValue<V> defineEnum(List<String> path,
 V defaultValue)

defineEnum

public <V extends Enum<V>>
ModConfigSpec.EnumValue<V> defineEnum(List<String> path,
 V defaultValue,
 com.electronwill.nightconfig.core.EnumGetMethod converter)

defineEnum

public <V extends Enum<V>>
ModConfigSpec.EnumValue<V> defineEnum(String path,
 V defaultValue,
 V... acceptableValues)

defineEnum

public <V extends Enum<V>>
ModConfigSpec.EnumValue<V> defineEnum(String path,
 V defaultValue,
 com.electronwill.nightconfig.core.EnumGetMethod converter,
 V... acceptableValues)

defineEnum

public <V extends Enum<V>>
ModConfigSpec.EnumValue<V> defineEnum(List<String> path,
 V defaultValue,
 V... acceptableValues)

defineEnum

public <V extends Enum<V>>
ModConfigSpec.EnumValue<V> defineEnum(List<String> path,
 V defaultValue,
 com.electronwill.nightconfig.core.EnumGetMethod converter,
 V... acceptableValues)

defineEnum

public <V extends Enum<V>>
ModConfigSpec.EnumValue<V> defineEnum(String path,
 V defaultValue,
 Collection<V> acceptableValues)

defineEnum

public <V extends Enum<V>>
ModConfigSpec.EnumValue<V> defineEnum(String path,
 V defaultValue,
 com.electronwill.nightconfig.core.EnumGetMethod converter,
 Collection<V> acceptableValues)

defineEnum

public <V extends Enum<V>>
ModConfigSpec.EnumValue<V> defineEnum(List<String> path,
 V defaultValue,
 Collection<V> acceptableValues)

defineEnum

public <V extends Enum<V>>
ModConfigSpec.EnumValue<V> defineEnum(List<String> path,
 V defaultValue,
 com.electronwill.nightconfig.core.EnumGetMethod converter,
 Collection<V> acceptableValues)

defineEnum

public <V extends Enum<V>>
ModConfigSpec.EnumValue<V> defineEnum(String path,
 V defaultValue,
 Predicate<Object> validator)

defineEnum

public <V extends Enum<V>>
ModConfigSpec.EnumValue<V> defineEnum(String path,
 V defaultValue,
 com.electronwill.nightconfig.core.EnumGetMethod converter,
 Predicate<Object> validator)

defineEnum

public <V extends Enum<V>>
ModConfigSpec.EnumValue<V> defineEnum(List<String> path,
 V defaultValue,
 Predicate<Object> validator)

defineEnum

public <V extends Enum<V>>
ModConfigSpec.EnumValue<V> defineEnum(List<String> path,
 V defaultValue,
 com.electronwill.nightconfig.core.EnumGetMethod converter,
 Predicate<Object> validator)

defineEnum

public <V extends Enum<V>>
ModConfigSpec.EnumValue<V> defineEnum(String path,
 Supplier<V> defaultSupplier,
 Predicate<Object> validator,
 Class<V> clazz)

defineEnum

public <V extends Enum<V>>
ModConfigSpec.EnumValue<V> defineEnum(String path,
 Supplier<V> defaultSupplier,
 com.electronwill.nightconfig.core.EnumGetMethod converter,
 Predicate<Object> validator,
 Class<V> clazz)

defineEnum

public <V extends Enum<V>>
ModConfigSpec.EnumValue<V> defineEnum(List<String> path,
 Supplier<V> defaultSupplier,
 Predicate<Object> validator,
 Class<V> clazz)

defineEnum

public <V extends Enum<V>>
ModConfigSpec.EnumValue<V> defineEnum(List<String> path,
 Supplier<V> defaultSupplier,
 com.electronwill.nightconfig.core.EnumGetMethod converter,
 Predicate<Object> validator,
 Class<V> clazz)

define

public ModConfigSpec.BooleanValue define(String path,
 boolean defaultValue)

define

public ModConfigSpec.BooleanValue define(List<String> path,
 boolean defaultValue)

define

public ModConfigSpec.BooleanValue define(String path,
 Supplier<Boolean> defaultSupplier)

define

public ModConfigSpec.BooleanValue define(List<String> path,
 Supplier<Boolean> defaultSupplier)

defineInRange

public ModConfigSpec.DoubleValue defineInRange(String path,
 double defaultValue,
 double min,
 double max)

defineInRange

public ModConfigSpec.DoubleValue defineInRange(List<String> path,
 double defaultValue,
 double min,
 double max)

defineInRange

public ModConfigSpec.DoubleValue defineInRange(String path,
 Supplier<Double> defaultSupplier,
 double min,
 double max)

defineInRange

public ModConfigSpec.DoubleValue defineInRange(List<String> path,
 Supplier<Double> defaultSupplier,
 double min,
 double max)

defineInRange

public ModConfigSpec.IntValue defineInRange(String path,
 int defaultValue,
 int min,
 int max)

defineInRange

public ModConfigSpec.IntValue defineInRange(List<String> path,
 int defaultValue,
 int min,
 int max)

defineInRange

public ModConfigSpec.IntValue defineInRange(String path,
 Supplier<Integer> defaultSupplier,
 int min,
 int max)

defineInRange

public ModConfigSpec.IntValue defineInRange(List<String> path,
 Supplier<Integer> defaultSupplier,
 int min,
 int max)

defineInRange

public ModConfigSpec.LongValue defineInRange(String path,
 long defaultValue,
 long min,
 long max)

defineInRange

public ModConfigSpec.LongValue defineInRange(List<String> path,
 long defaultValue,
 long min,
 long max)

defineInRange

public ModConfigSpec.LongValue defineInRange(String path,
 Supplier<Long> defaultSupplier,
 long min,
 long max)

defineInRange

public ModConfigSpec.LongValue defineInRange(List<String> path,
 Supplier<Long> defaultSupplier,
 long min,
 long max)

comment

public ModConfigSpec.Builder comment(String comment)

comment

public ModConfigSpec.Builder comment(String... comment)

translation

public ModConfigSpec.Builder translation(String translationKey)

worldRestart

public ModConfigSpec.Builder worldRestart()

Config values marked as needing a world restart will not reset their cached value until they are unloaded (i.e. when a world is closed).

gameRestart

public ModConfigSpec.Builder gameRestart()

Config values marked as needing a game restart will never reset their cached value.

push

public ModConfigSpec.Builder push(String path)

push

public ModConfigSpec.Builder push(List<String> path)

pop

public ModConfigSpec.Builder pop()

pop

public ModConfigSpec.Builder pop(int count)

configure

public <T>
org.apache.commons.lang3.tuple.Pair<T,ModConfigSpec> configure(Function<ModConfigSpec.Builder,T> consumer)

build

public ModConfigSpec build()