Package net.neoforged.neoforge.common

Class ModConfigSpec.ConfigValue<T>

java.lang.Object

net.neoforged.neoforge.common.ModConfigSpec.ConfigValue<T>

All Implemented Interfaces:

Supplier<T>

Direct Known Subclasses:

ModConfigSpec.BooleanValue, ModConfigSpec.DoubleValue, ModConfigSpec.EnumValue, ModConfigSpec.IntValue, ModConfigSpec.LongValue

Enclosing class:

ModConfigSpec

public static class ModConfigSpec.ConfigValue<T>
extends Object
implements Supplier<T>

Field Summary

Fields

Modifier and Type	Field	Description
private T	cachedValue
private final Supplier<T>	defaultSupplier
private final ModConfigSpec.Builder	parent
private final List<String>	path
private @Nullable ModConfigSpec	spec

Constructor Summary

Constructors

Constructor	Description
ConfigValue(ModConfigSpec.Builder parent, List<String> path, Supplier<T> defaultSupplier)

Method Summary

Modifier and Type	Method	Description
void	clearCache()
T	get()	Returns the configured value for the configuration setting, throwing if the config has not yet been loaded.
T	getDefault()	Returns the default value for the configuration setting.
List<String>	getPath()
T	getRaw()	Returns the uncached value for the configuration setting, throwing if the config has not yet been loaded.
T	getRaw(com.electronwill.nightconfig.core.Config config, List<String> path, Supplier<T> defaultSupplier)
ModConfigSpec.ValueSpec	getSpec()
ModConfigSpec.Builder	next()
void	save()
void	set(T value)	Directly sets the value, without firing events or writing the config to disk.

Methods inherited from class java.lang.Object

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

Field Details

parent

private final ModConfigSpec.Builder parent

path

private final List<String> path

defaultSupplier

private final Supplier<T> defaultSupplier

cachedValue

@Nullable
private T cachedValue

spec

@Nullable
private @Nullable ModConfigSpec spec

Constructor Details

ConfigValue

ConfigValue(ModConfigSpec.Builder parent,
 List<String> path,
 Supplier<T> defaultSupplier)

Method Details

getPath

public List<String> getPath()

get

public T get()

Returns the configured value for the configuration setting, throwing if the config has not yet been loaded.

This getter is cached, and will respect the world restart and game restart options by not clearing its cache if one of those options are set.

Specified by:

get in interface Supplier<T>

Returns:

the configured value for the setting

Throws:

NullPointerException - if the config spec object that will contain this has not yet been built

IllegalStateException - if the associated config has not yet been loaded

getRaw

public T getRaw()

Returns the uncached value for the configuration setting, throwing if the config has not yet been loaded.

Do not call this for any other purpose than editing the value. Use get() instead.

getRaw

public T getRaw(com.electronwill.nightconfig.core.Config config,
 List<String> path,
 Supplier<T> defaultSupplier)

getDefault

public T getDefault()

Returns the default value for the configuration setting.

Returns:

the default value for the configuration setting

next

public ModConfigSpec.Builder next()

save

public void save()

set

public void set(T value)

Directly sets the value, without firing events or writing the config to disk. Make sure to call ModConfigSpec.save() eventually.

getSpec

public ModConfigSpec.ValueSpec getSpec()

clearCache

public void clearCache()