Package codechicken.lib.config

Interface ConfigCategory

All Superinterfaces:

ConfigTag

All Known Implementing Classes:

ConfigCategoryImpl

public interface ConfigCategory
extends ConfigTag

Created by covers1624 on 17/4/22.

Method Summary

Modifier and Type	Method	Description
void	clear()	Removes all children from this tag.
ConfigCategory	delete(String name)	Deletes the tag with the given name.
@Nullable ConfigCategory	findCategory(String name)	Gets the ConfigCategory with the given name, or null.
@Nullable ConfigTag	findTag(String name)	Gets the ConfigTag with the given name, or null.
@Nullable ConfigValue	findValue(String name)	Gets the ConfigValue with the given name, or null.
@Nullable ConfigValueList	findValueList(String name)	Gets the ConfigValueList with the given name, or null.
ConfigCategory	getCategory(String name)	Gets or creates a ConfigCategory with the given name.
Collection<ConfigTag>	getChildren()	Gets all child tags contained in this Category.
ConfigValue	getValue(String name)	Gets or creates a ConfigValue with the given name.
ConfigValueList	getValueList(String name)	Gets or creates a ConfigValueList with the given name.
boolean	has(String name)	Checks if this tag has a child with the given name.
ConfigCategory	onSync(ConfigCallback<ConfigCategory> callback)
ConfigCategory	setComment(String comment)	Sets the comment for this tag. Will be split on \n.
ConfigCategory	setComment(String... comment)	Sets the comment for this tag.
ConfigCategory	setComment(List<String> comment)	Sets the comment for this tag.
ConfigCategory	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

has

boolean has(String name)

Checks if this tag has a child with the given name.

Parameters:

name - The name.

Returns:

If the child exists.

findTag

@Nullable
@Nullable ConfigTag findTag(String name)

Gets the ConfigTag with the given name, or null.

Parameters:

name - The name.

Returns:

The ConfigTag or null if it doesn't exist.

getCategory

ConfigCategory getCategory(String name)

Gets or creates a ConfigCategory with the given name.

Parameters:

name - The name.

Returns:

The ConfigCategory.

Throws:

IllegalStateException - If a ConfigTag exists, but it is not a ConfigCategory.

findCategory

@Nullable
@Nullable ConfigCategory findCategory(String name)

Gets the ConfigCategory with the given name, or null.

This will return null if the ConfigTag at the name is not a ConfigCategory or it does not exist.

Parameters:

name - The name.

Returns:

The ConfigCategory or null.

getValue

ConfigValue getValue(String name)

Gets or creates a ConfigValue with the given name.

Parameters:

name - The name.

Returns:

The ConfigValue.

Throws:

IllegalStateException - If a ConfigTag exists, but it is not a ConfigValue.

findValue

@Nullable
@Nullable ConfigValue findValue(String name)

Gets the ConfigValue with the given name, or null.

This will return null if the ConfigTag at the name is not a ConfigValue or it does not exist.

Parameters:

name - The name.

Returns:

The ConfigValue or null

getValueList

ConfigValueList getValueList(String name)

Gets or creates a ConfigValueList with the given name.

Parameters:

name - The name.

Returns:

The ConfigValueList.

Throws:

IllegalStateException - If a ConfigTag exists, but it is not a ConfigValueList.

findValueList

@Nullable
@Nullable ConfigValueList findValueList(String name)

Gets the ConfigValueList with the given name, or null.

This will return null if the ConfigTag at the name is not a ConfigValueList or it does not exist.

Parameters:

name - The name.

Returns:

The ConfigValueList or null

getChildren

Collection<ConfigTag> getChildren()

Gets all child tags contained in this Category.

Returns:

All the child tags.

delete

ConfigCategory delete(String name)

Deletes the tag with the given name.

If the tag does not exist, this method does nothing.

Parameters:

name - The name of the tag to delete.

Returns:

The same config tag.

clear

void clear()

Removes all children from this tag.

syncTagToClient

ConfigCategory 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

ConfigCategory onSync(ConfigCallback<ConfigCategory> callback)

setComment

ConfigCategory 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

ConfigCategory 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

ConfigCategory 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.