All Superinterfaces:: ConfigTag

All Known Implementing Classes:: ConfigValueListImpl

public interface ConfigValueList extends ConfigTag

Created by covers1624 on 18/4/22.

Method Summary

Modifier and Type

Method

Description

it.unimi.dsi.fastutil.booleans.BooleanList

getBooleans()

Gets the BooleanList values stored in this tag.

it.unimi.dsi.fastutil.booleans.BooleanList

getDefaultBooleans()

Gets the default BooleanList values stored in this tag.

it.unimi.dsi.fastutil.doubles.DoubleList

getDefaultDoubles()

Gets the default DoubleList values stored in this tag.

it.unimi.dsi.fastutil.ints.IntList

getDefaultHexs()

Gets the default IntList values represented as Hex strings stored in this tag.

it.unimi.dsi.fastutil.ints.IntList

getDefaultInts()

Gets the default IntList values stored in this tag.

it.unimi.dsi.fastutil.longs.LongList

getDefaultLongs()

Gets the default LongList values stored in this tag.

List<String>

getDefaultStrings()

Gets the default List of String values stored in this tag.

it.unimi.dsi.fastutil.doubles.DoubleList

getDoubles()

Gets the DoubleList values stored in this tag.

it.unimi.dsi.fastutil.ints.IntList

getHexs()

Gets the IntList values stored as a Hex strings stored in this tag.

it.unimi.dsi.fastutil.ints.IntList

getInts()

Gets the IntList values stored in this tag.

it.unimi.dsi.fastutil.longs.LongList

getLongs()

Gets the LongList value stored in this tag.

@Nullable ListRestriction

getRestriction()

Gets the Restriction predicate for this tag.

List<String>

getStrings()

Gets the List of String values stored in this tag.

ValueType

getType()

Gets the type of the ConfigValueList.

ConfigValueList

onSync(ConfigCallback<ConfigValueList> callback)

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

ConfigValueList

setBooleans(List<Boolean> values)

Sets the List of Boolean values stored in this tag.

ConfigValueList

setComment(String comment)

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

ConfigValueList

setComment(String... comment)

Sets the comment for this tag.

ConfigValueList

setComment(List<String> comment)

Sets the comment for this tag.

ConfigValueList

setDefaultBooleans(List<Boolean> values)

Sets the default List of Boolean values stored in this tag.

ConfigValueList

setDefaultDoubles(List<Double> values)

Sets the default List of Double values stored in this tag.

ConfigValueList

setDefaultHexs(List<Integer> values)

Sets the default List of Integer values represented as hex Strings stored in this tag.

ConfigValueList

setDefaultInts(List<Integer> values)

Sets the default List of Integer values stored in this tag.

ConfigValueList

setDefaultLongs(List<Long> values)

Sets the default List of Long values stored in this tag.

ConfigValueList

setDefaultStrings(List<String> values)

Sets the default List of String values stored in this tag.

ConfigValueList

setDoubles(List<Double> values)

Sets the List of Double values stored in this tag.

ConfigValueList

setHexs(List<Integer> values)

Sets the List of Integer values represented as hex Strings stored in this tag.

ConfigValueList

setInts(List<Integer> values)

Sets the List of Integer values stored in this tag.

ConfigValueList

setLongs(List<Long> values)

Sets the List of Long values stored in this tag.

ConfigValueList

setRestriction(ListRestriction restriction)

// TODO Improve wording for lists.

ConfigValueList

setStrings(List<String> values)

Sets the List of String values stored in this tag.

ConfigValueList

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 ConfigValueList.
  
  Returns:
  
  The ValueType of this tag.
- getBooleans
  
  it.unimi.dsi.fastutil.booleans.BooleanList getBooleans()
  
  Gets the BooleanList values stored in 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.
- getStrings
  
  List<String> getStrings()
  
  Gets the List of String values stored in 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.
- getInts
  
  it.unimi.dsi.fastutil.ints.IntList getInts()
  
  Gets the IntList values stored in 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.
- getLongs
  
  it.unimi.dsi.fastutil.longs.LongList getLongs()
  
  Gets the LongList value stored in 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.
- getHexs
  
  it.unimi.dsi.fastutil.ints.IntList getHexs()
  
  Gets the IntList values stored as a Hex strings stored in 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.
- getDoubles
  
  it.unimi.dsi.fastutil.doubles.DoubleList getDoubles()
  
  Gets the DoubleList values stored in 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.
- setBooleans
  
  ConfigValueList setBooleans(List<Boolean> values)
  
  Sets the List of Boolean values stored in this tag.
  If the tag has an ValueType.UNKNOWN value type, this function will set it appropriately.
  
  Parameters:
  
  values - The List of Boolean values.
  
  Returns:
  
  The same ConfigValueList.
  
  Throws:
  
  IllegalStateException - If the getType() is not ValueType.UNKNOWN or ValueType.BOOLEAN.
- setStrings
  
  ConfigValueList setStrings(List<String> values)
  
  Sets the List of String values stored in this tag.
  If the tag has an ValueType.UNKNOWN value type, this function will set it appropriately.
  
  Parameters:
  
  values - The List of String values.
  
  Returns:
  
  The same ConfigValueList.
  
  Throws:
  
  IllegalStateException - If the getType() is not ValueType.UNKNOWN or ValueType.STRING.
- setInts
  
  ConfigValueList setInts(List<Integer> values)
  
  Sets the List of Integer values stored in this tag.
  If the tag has an ValueType.UNKNOWN value type, this function will set it appropriately.
  
  Parameters:
  
  values - The List of Integer values.
  
  Returns:
  
  The same ConfigValueList.
  
  Throws:
  
  IllegalStateException - If the getType() is not ValueType.UNKNOWN or ValueType.INT.
- setLongs
  
  ConfigValueList setLongs(List<Long> values)
  
  Sets the List of Long values stored in this tag.
  If the tag has an ValueType.UNKNOWN value type, this function will set it appropriately.
  
  Parameters:
  
  values - The List of Long values.
  
  Returns:
  
  The same ConfigValueList.
  
  Throws:
  
  IllegalStateException - If the getType() is not ValueType.UNKNOWN or ValueType.LONG.
- setHexs
  
  ConfigValueList setHexs(List<Integer> values)
  
  Sets the List of Integer values represented as hex Strings stored in this tag.
  If the tag has an ValueType.UNKNOWN value type, this function will set it appropriately.
  
  Parameters:
  
  values - The List of Integer values.
  
  Returns:
  
  The same ConfigValueList.
  
  Throws:
  
  IllegalStateException - If the getType() is not ValueType.UNKNOWN or ValueType.HEX.
- setDoubles
  
  ConfigValueList setDoubles(List<Double> values)
  
  Sets the List of Double values stored in this tag.
  If the tag has an ValueType.UNKNOWN value type, this function will set it appropriately.
  
  Parameters:
  
  values - The List of Double values.
  
  Returns:
  
  The same ConfigValueList.
  
  Throws:
  
  IllegalStateException - If the getType() is not ValueType.UNKNOWN or ValueType.DOUBLE.
- getDefaultBooleans
  
  it.unimi.dsi.fastutil.booleans.BooleanList getDefaultBooleans()
  
  Gets the default BooleanList values stored in 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 BooleanList values.
  
  Throws:
  
  IllegalStateException - If the getType() is not ValueType.BOOLEAN, or when no default is set.
- getDefaultStrings
  
  List<String> getDefaultStrings()
  
  Gets the default List of String values stored in 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 List of String values.
  
  Throws:
  
  IllegalStateException - If the getType() is not ValueType.STRING, or when no default is set.
- getDefaultInts
  
  it.unimi.dsi.fastutil.ints.IntList getDefaultInts()
  
  Gets the default IntList values stored in 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 LongList values.
  
  Throws:
  
  IllegalStateException - If the getType() is not ValueType.INT, or when no default is set.
- getDefaultLongs
  
  it.unimi.dsi.fastutil.longs.LongList getDefaultLongs()
  
  Gets the default LongList values stored in 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 LongList values.
  
  Throws:
  
  IllegalStateException - If the getType() is not ValueType.LONG, or when no default is set.
- getDefaultHexs
  
  it.unimi.dsi.fastutil.ints.IntList getDefaultHexs()
  
  Gets the default IntList values represented as Hex strings stored in 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 IntList values.
  
  Throws:
  
  IllegalStateException - If the getType() is not ValueType.HEX, or when no default is set.
- getDefaultDoubles
  
  it.unimi.dsi.fastutil.doubles.DoubleList getDefaultDoubles()
  
  Gets the default DoubleList values stored in 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 DoubleList values.
  
  Throws:
  
  IllegalStateException - If the getType() is not ValueType.DOUBLE, or when no default is set.
- setDefaultBooleans
  
  ConfigValueList setDefaultBooleans(List<Boolean> values)
  
  Sets the default List of Boolean values stored in this tag.
  If the tag has an ValueType.UNKNOWN value type, this function will set it appropriately.
  
  Parameters:
  
  values - The List of Boolean values.
  
  Returns:
  
  The same ConfigValueList.
  
  Throws:
  
  IllegalStateException - If the getType() is not ValueType.UNKNOWN or ValueType.BOOLEAN.
- setDefaultStrings
  
  ConfigValueList setDefaultStrings(List<String> values)
  
  Sets the default List of String values stored in this tag.
  If the tag has an ValueType.UNKNOWN value type, this function will set it appropriately.
  
  Parameters:
  
  values - The List of String values.
  
  Returns:
  
  The same ConfigValueList.
  
  Throws:
  
  IllegalStateException - If the getType() is not ValueType.UNKNOWN or ValueType.STRING.
- setDefaultInts
  
  ConfigValueList setDefaultInts(List<Integer> values)
  
  Sets the default List of Integer values stored in this tag.
  If the tag has an ValueType.UNKNOWN value type, this function will set it appropriately.
  
  Parameters:
  
  values - The List of Integer values.
  
  Returns:
  
  The same ConfigValueList.
  
  Throws:
  
  IllegalStateException - If the getType() is not ValueType.UNKNOWN or ValueType.INT.
- setDefaultLongs
  
  ConfigValueList setDefaultLongs(List<Long> values)
  
  Sets the default List of Long values stored in this tag.
  If the tag has an ValueType.UNKNOWN value type, this function will set it appropriately.
  
  Parameters:
  
  values - The List of Long values.
  
  Returns:
  
  The same ConfigValueList.
  
  Throws:
  
  IllegalStateException - If the getType() is not ValueType.UNKNOWN or ValueType.LONG.
- setDefaultHexs
  
  ConfigValueList setDefaultHexs(List<Integer> values)
  
  Sets the default List of Integer values represented as hex Strings stored in this tag.
  If the tag has an ValueType.UNKNOWN value type, this function will set it appropriately.
  
  Parameters:
  
  values - The List of Integer values.
  
  Returns:
  
  The same ConfigValueList.
  
  Throws:
  
  IllegalStateException - If the getType() is not ValueType.UNKNOWN or ValueType.HEX.
- setDefaultDoubles
  
  ConfigValueList setDefaultDoubles(List<Double> values)
  
  Sets the default List of Double values stored in this tag.
  If the tag has an ValueType.UNKNOWN value type, this function will set it appropriately.
  
  Parameters:
  
  values - The List of Double values.
  
  Returns:
  
  The same ConfigValueList.
  
  Throws:
  
  IllegalStateException - If the getType() is not ValueType.UNKNOWN or ValueType.DOUBLE.
- setRestriction
  
  ConfigValueList setRestriction(ListRestriction restriction)
  
  // TODO Improve wording for lists. Set the Restriction for this ConfigValueList.
  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 ConfigValueList.
  
  See Also:
  
  Restriction
- getRestriction
  
  @Nullable @Nullable ListRestriction getRestriction()
  
  Gets the Restriction predicate for this tag.
  
  Returns:
  
  The Restriction
- syncTagToClient
  
  ConfigValueList 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
  
  ConfigValueList onSync(ConfigCallback<ConfigValueList> 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 ConfigValueList.
  
  See Also:
  
  ConfigCallback
- setComment
  
  ConfigValueList 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
  
  ConfigValueList 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
  
  ConfigValueList 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.

Interface ConfigValueList

Method Summary

Methods inherited from interface codechicken.lib.config.ConfigTag

Method Details

getType

getBooleans

getStrings

getInts

getLongs

getHexs

getDoubles

setBooleans

setStrings

setInts

setLongs

setHexs

setDoubles

getDefaultBooleans

getDefaultStrings

getDefaultInts

getDefaultLongs

getDefaultHexs

getDefaultDoubles

setDefaultBooleans

setDefaultStrings

setDefaultInts

setDefaultLongs

setDefaultHexs

setDefaultDoubles

setRestriction

getRestriction

syncTagToClient

onSync

setComment

setComment

setComment