Package codechicken.lib.config

Interface ConfigValue

All Superinterfaces:

ConfigTag

All Known Implementing Classes:

ConfigValueImpl

public interface ConfigValue
extends ConfigTag

Represents a ConfigTag with a value of a specific type.

Created by covers1624 on 17/4/22.

Method Summary

Modifier and Type	Method	Description
boolean	getBoolean()	Gets the boolean value of this tag.
boolean	getDefaultBoolean()	Gets the default boolean value of this tag.
double	getDefaultDouble()	Gets the default double value of this tag.
int	getDefaultHex()	Gets the default int value stored as a Hex String of this tag.
int	getDefaultInt()	Gets the default int value of this tag.
long	getDefaultLong()	Gets the default long value of this tag.
String	getDefaultString()	Gets the default String value of this tag.
double	getDouble()	Gets the double value of this tag.
int	getHex()	Gets the int value stored as a Hex String of this tag.
int	getInt()	Gets the int value of this tag.
long	getLong()	Gets the long value of this tag.
@Nullable Restriction	getRestriction()	Gets the Restriction predicate for this tag.
String	getString()	Gets the String value of this tag.
ValueType	getType()	Gets the type of the ConfigValue.
ConfigValue	onSync(ConfigCallback<ConfigValue> callback)	Called when this tag, or any children, are modified.
ConfigValue	setBoolean(boolean value)	Sets the boolean value of this tag.
ConfigValue	setComment(String comment)	Sets the comment for this tag. Will be split on \n.
ConfigValue	setComment(String... comment)	Sets the comment for this tag.
ConfigValue	setComment(List<String> comment)	Sets the comment for this tag.
ConfigValue	setDefaultBoolean(boolean value)	Sets the default boolean value of this tag.
ConfigValue	setDefaultDouble(double value)	Sets the default double value of this tag.
ConfigValue	setDefaultHex(int value)	Sets the default int value represented as a hex String of this tag.
ConfigValue	setDefaultInt(int value)	Sets the default int value of this tag.
ConfigValue	setDefaultLong(long value)	Sets the default long value of this tag.
ConfigValue	setDefaultString(String value)	Sets the default String value of this tag.
ConfigValue	setDouble(double value)	Sets the double value of this tag.
ConfigValue	setHex(int value)	Sets the int value represented as a hex String of this tag.
ConfigValue	setInt(int value)	Sets the int value of this tag.
ConfigValue	setLong(long value)	Sets the long value of this tag.
ConfigValue	setRestriction(Restriction restriction)	Set the Restriction for this ConfigValue.
ConfigValue	setString(String value)	Sets the String value of this tag.
ConfigValue	syncTagToClient()	Sets this tag as requiring syncing to the client.

Methods inherited from interface codechicken.lib.config.ConfigTag

copy, delete, forceSync, getComment, getDesc, getName, getParent, isDirty, isNetworkTag, read, requiresClientSync, reset, resetFromNetwork, runSync, save, write

Method Details

getType

ValueType getType()

Gets the type of the ConfigValue.

Returns:

The ValueType of this tag.

getBoolean

boolean getBoolean()

Gets the boolean value of this tag.

No attempt to convert between tag types is made, this must be called on a tag which has a non ValueType.UNKNOWN type.

Returns:

The boolean value or the default.

Throws:

IllegalStateException - If the getType() is not ValueType.BOOLEAN, or in the event of a missing value, no default is set.

getString

String getString()

Gets the String value of this tag.

No attempt to convert between tag types is made, this must be called on a tag which has a non ValueType.UNKNOWN type.

Returns:

The String value or the default.

Throws:

IllegalStateException - If the getType() is not ValueType.STRING, or in the event of a missing value, no default is set.

getInt

int getInt()

Gets the int value of this tag.

No attempt to convert between tag types is made, this must be called on a tag which has a non ValueType.UNKNOWN type.

Returns:

The int value or the default.

Throws:

IllegalStateException - If the getType() is not ValueType.INT, or in the event of a missing value, no default is set.

getLong

long getLong()

Gets the long value of this tag.

No attempt to convert between tag types is made, this must be called on a tag which has a non ValueType.UNKNOWN type.

Returns:

The long value or the default.

Throws:

IllegalStateException - If the getType() is not ValueType.LONG, or in the event of a missing value, no default is set.

getHex

int getHex()

Gets the int value stored as a Hex String of this tag.

No attempt to convert between tag types is made, this must be called on a tag which has a non ValueType.UNKNOWN type.

Returns:

The int value or the default.

Throws:

IllegalStateException - If the getType() is not ValueType.HEX, or in the event of a missing value, no default is set.

getDouble

double getDouble()

Gets the double value of this tag.

No attempt to convert between tag types is made, this must be called on a tag which has a non ValueType.UNKNOWN type.

Returns:

The double value or the default.

Throws:

IllegalStateException - If the getType() is not ValueType.DOUBLE, or in the event of a missing value, no default is set.

setBoolean

ConfigValue setBoolean(boolean value)

Sets the boolean value of this tag.

If the tag has an ValueType.UNKNOWN value type, this function will set it appropriately.

Parameters:

value - The boolean value.

Returns:

The same ConfigValue.

Throws:

IllegalStateException - If the getType() is not ValueType.UNKNOWN or ValueType.BOOLEAN.

setString

ConfigValue setString(String value)

Sets the String value of this tag.

If the tag has an ValueType.UNKNOWN value type, this function will set it appropriately.

Parameters:

value - The String value.

Returns:

The same ConfigValue.

Throws:

IllegalStateException - If the getType() is not ValueType.UNKNOWN or ValueType.STRING.

setInt

ConfigValue setInt(int value)

Sets the int value of this tag.

If the tag has an ValueType.UNKNOWN value type, this function will set it appropriately.

Parameters:

value - The int value.

Returns:

The same ConfigValue.

Throws:

IllegalStateException - If the getType() is not ValueType.UNKNOWN or ValueType.INT.

setLong

ConfigValue setLong(long value)

Sets the long value of this tag.

If the tag has an ValueType.UNKNOWN value type, this function will set it appropriately.

Parameters:

value - The long value.

Returns:

The same ConfigValue.

Throws:

IllegalStateException - If the getType() is not ValueType.UNKNOWN or ValueType.LONG.

setHex

ConfigValue setHex(int value)

Sets the int value represented as a hex String of this tag.

If the tag has an ValueType.UNKNOWN value type, this function will set it appropriately.

Parameters:

value - The int value.

Returns:

The same ConfigValue.

Throws:

IllegalStateException - If the getType() is not ValueType.UNKNOWN or ValueType.HEX.

setDouble

ConfigValue setDouble(double value)

Sets the double value of this tag.

If the tag has an ValueType.UNKNOWN value type, this function will set it appropriately.

Parameters:

value - The double value.

Returns:

The same ConfigValue.

Throws:

IllegalStateException - If the getType() is not ValueType.UNKNOWN or ValueType.DOUBLE.

getDefaultBoolean

boolean getDefaultBoolean()

Gets the default boolean value of this tag.

No attempt to convert between tag types is made, this must be called on a tag which has a non ValueType.UNKNOWN type.

Returns:

The default boolean value.

Throws:

IllegalStateException - If the getType() is not ValueType.BOOLEAN, or when no default is set.

getDefaultString

String getDefaultString()

Gets the default String value of this tag.

No attempt to convert between tag types is made, this must be called on a tag which has a non ValueType.UNKNOWN type.

Returns:

The default String value.

Throws:

IllegalStateException - If the getType() is not ValueType.STRING, or when no default is set.

getDefaultInt

int getDefaultInt()

Gets the default int value of this tag.

No attempt to convert between tag types is made, this must be called on a tag which has a non ValueType.UNKNOWN type.

Returns:

The default int value.

Throws:

IllegalStateException - If the getType() is not ValueType.INT, or when no default is set.

getDefaultLong

long getDefaultLong()

Gets the default long value of this tag.

No attempt to convert between tag types is made, this must be called on a tag which has a non ValueType.UNKNOWN type.

Returns:

The default long value.

Throws:

IllegalStateException - If the getType() is not ValueType.LONG, or when no default is set.

getDefaultHex

int getDefaultHex()

Gets the default int value stored as a Hex String of this tag.

No attempt to convert between tag types is made, this must be called on a tag which has a non ValueType.UNKNOWN type.

Returns:

The default int value.

Throws:

IllegalStateException - If the getType() is not ValueType.HEX, or when no default is set.

getDefaultDouble

double getDefaultDouble()

Gets the default double value of this tag.

No attempt to convert between tag types is made, this must be called on a tag which has a non ValueType.UNKNOWN type.

Returns:

The default double value.

Throws:

IllegalStateException - If the getType() is not ValueType.DOUBLE, or when no default is set.

setDefaultBoolean

ConfigValue setDefaultBoolean(boolean value)

Sets the default boolean value of this tag.

If the tag has an ValueType.UNKNOWN value type, this function will set it appropriately.

Parameters:

value - The boolean value.

Returns:

The same ConfigValue.

Throws:

IllegalStateException - If the getType() is not ValueType.UNKNOWN or ValueType.BOOLEAN.

setDefaultString

ConfigValue setDefaultString(String value)

Sets the default String value of this tag.

If the tag has an ValueType.UNKNOWN value type, this function will set it appropriately.

Parameters:

value - The String value.

Returns:

The same ConfigValue.

Throws:

IllegalStateException - If the getType() is not ValueType.UNKNOWN or ValueType.STRING.

setDefaultInt

ConfigValue setDefaultInt(int value)

Sets the default int value of this tag.

If the tag has an ValueType.UNKNOWN value type, this function will set it appropriately.

Parameters:

value - The int value.

Returns:

The same ConfigValue.

Throws:

IllegalStateException - If the getType() is not ValueType.UNKNOWN or ValueType.INT.

setDefaultLong

ConfigValue setDefaultLong(long value)

Sets the default long value of this tag.

If the tag has an ValueType.UNKNOWN value type, this function will set it appropriately.

Parameters:

value - The long value.

Returns:

The same ConfigValue.

Throws:

IllegalStateException - If the getType() is not ValueType.UNKNOWN or ValueType.LONG.

setDefaultHex

ConfigValue setDefaultHex(int value)

Sets the default int value represented as a hex String of this tag.

If the tag has an ValueType.UNKNOWN value type, this function will set it appropriately.

Parameters:

value - The int value.

Returns:

The same ConfigValue.

Throws:

IllegalStateException - If the getType() is not ValueType.UNKNOWN or ValueType.HEX.

setDefaultDouble

ConfigValue setDefaultDouble(double value)

Sets the default double value of this tag.

If the tag has an ValueType.UNKNOWN value type, this function will set it appropriately.

Parameters:

value - The double value.

Returns:

The same ConfigValue.

Throws:

IllegalStateException - If the getType() is not ValueType.UNKNOWN or ValueType.DOUBLE.

setRestriction

ConfigValue setRestriction(Restriction restriction)

Set the Restriction for this ConfigValue.

A restriction is just a Predicate, and can be used for anything, but is most commonly used for int/float value ranges on tags.

If the restriction is violated, either by the tag being loaded from disk, or via a set method, it will be reset to default.

TODO, in the future, provide a function to choose what to do when a value is invalid, allow the value to be altered (clamped), removed, or reset entirely to default. It is invalid for the restriction to not accept the tag's default value, if the restriction does not, it will throw an IllegalArgumentException either when the restriction is set, or the default is set, whichever comes last.

See Restriction for more information.

Parameters:

restriction - The restriction to set.

Returns:

The same ConfigValue.

See Also:

• Restriction

getRestriction

@Nullable
@Nullable Restriction getRestriction()

Gets the Restriction predicate for this tag.

Returns:

The Restriction

syncTagToClient

ConfigValue syncTagToClient()

Sets this tag as requiring syncing to the client.

Register your root tag via ConfigSyncManager.registerSync(ResourceLocation, ConfigTag).

Specified by:

syncTagToClient in interface ConfigTag

onSync

ConfigValue onSync(ConfigCallback<ConfigValue> callback)

Called when this tag, or any children, are modified.

This is commonly used for when tags are synced to the client and inversely, reverted when disconnecting.

Additionally, one can manually fire all sync callbacks using ConfigTag.forceSync()

See ConfigCallback for more info.

Parameters:

callback - The ConfigCallback.

Returns:

The same ConfigValue.

See Also:

• ConfigCallback

setComment

ConfigValue setComment(String comment)

Sets the comment for this tag.
Will be split on \n.

Specified by:

setComment in interface ConfigTag

Parameters:

comment - The comment line.

Returns:

The same config tag.

setComment

ConfigValue setComment(String... comment)

Sets the comment for this tag.

Specified by:

setComment in interface ConfigTag

Parameters:

comment - The comment lines.

Returns:

The same config tag.

setComment

ConfigValue setComment(List<String> comment)

Sets the comment for this tag.

Specified by:

setComment in interface ConfigTag

Parameters:

comment - The comment lines.

Returns:

The same config tag.