Enum Class ConfigScope

java.lang.Object

java.lang.Enum<ConfigScope>

johnsmith.configoverhauled.api.data.ConfigScope

All Implemented Interfaces:

Serializable, Comparable<ConfigScope>, Constable

public enum ConfigScope
extends Enum<ConfigScope>

Defines the serialization boundaries, disk storage location, and network synchronization rules for a configuration property.

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CLIENT	Operates exclusively within the local client environment.
GLOBAL	Operates universally across the environment instance.
LEVEL	Operates strictly within the boundary of a specific world instance.

Method Summary

Modifier and Type	Method	Description
static ConfigScope	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ConfigScope[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

CLIENT

public static final ConfigScope CLIENT

Operates exclusively within the local client environment. Serialized to the root config directory. Rejects authoritative updates from active server connections.

GLOBAL

public static final ConfigScope GLOBAL

Operates universally across the environment instance. Serialized to the root config directory. Applies to all local single-player levels or globally dictates behavior on a dedicated server.

LEVEL

public static final ConfigScope LEVEL

Operates strictly within the boundary of a specific world instance. Serialized to the level save directory. Server acts as the authoritative state and strictly synchronizes properties to all connected clients.

Method Details

values

public static ConfigScope[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static ConfigScope valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null