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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ModConfigSpec.Builder.BuilderConsumer

Field Summary

Fields

Modifier and Type	Field	Description
private ModConfigSpec.BuilderContext	context
private List<String>	currentPath
private Map<List<String>,String>	levelComments
private Map<List<String>,String>	levelTranslationKeys
private final com.electronwill.nightconfig.core.Config	storage
private 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)
<T> ModConfigSpec.ConfigValue<List<? extends T>>	defineList(String path, List<? extends T> defaultValue, Predicate<Object> elementValidator)
<T> ModConfigSpec.ConfigValue<List<? extends T>>	defineList(List<String> path, Supplier<List<? extends T>> defaultSupplier, Predicate<Object> elementValidator)
<T> ModConfigSpec.ConfigValue<List<? extends T>>	defineList(List<String> path, List<? extends T> defaultValue, Predicate<Object> elementValidator)
<T> ModConfigSpec.ConfigValue<List<? extends T>>	defineListAllowEmpty(String path, Supplier<List<? extends T>> defaultSupplier, Predicate<Object> elementValidator)
<T> ModConfigSpec.ConfigValue<List<? extends T>>	defineListAllowEmpty(String path, List<? extends T> defaultValue, Predicate<Object> elementValidator)
<T> ModConfigSpec.ConfigValue<List<? extends T>>	defineListAllowEmpty(List<String> path, Supplier<List<? extends T>> defaultSupplier, Predicate<Object> elementValidator)
<T> ModConfigSpec.ConfigValue<List<? extends T>>	defineListAllowEmpty(List<String> path, List<? extends T> defaultValue, Predicate<Object> elementValidator)
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()

Methods inherited from class java.lang.Object

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

Field Details

storage

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

context

private ModConfigSpec.BuilderContext context

levelComments

private Map<List<String>,String> levelComments

levelTranslationKeys

private Map<List<String>,String> levelTranslationKeys

currentPath

private List<String> currentPath

values

private 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

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

defineList

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

defineList

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

defineList

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

defineListAllowEmpty

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

defineListAllowEmpty

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

defineListAllowEmpty

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

defineListAllowEmpty

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

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()

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()