Package net.kyori.adventure.internal.properties

Class AdventureProperties

java.lang.Object

net.kyori.adventure.internal.properties.AdventureProperties

@Internal
public final class AdventureProperties
extends Object

Adventure properties.

Since:

4.10.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AdventureProperties.DefaultOverrideProvider	A service provider that allows default property values to be overridden.
static interface	AdventureProperties.Property<T>	A property.

Field Summary

Fields

Modifier and Type	Field	Description
static final AdventureProperties.Property<Boolean>	DEBUG	Property for specifying whether debug mode is enabled.
static final AdventureProperties.Property<Integer>	DEFAULT_FLATTENER_NESTING_LIMIT	Property for setting a global default for flattener nesting.
static final AdventureProperties.Property<String>	DEFAULT_TRANSLATION_LOCALE	Property for specifying the default translation locale.
static final AdventureProperties.Property<Boolean>	SERVICE_LOAD_FAILURES_ARE_FATAL	Property for specifying whether service load failures are fatal.
static final AdventureProperties.Property<Boolean>	TEXT_WARN_WHEN_LEGACY_FORMATTING_DETECTED	Property for specifying whether to warn when legacy formatting is detected.

Method Summary

Modifier and Type	Method	Description
static <T> @NotNull AdventureProperties.Property<T>	property(@NotNull String name, @NotNull Function<String,T> parser, T defaultValue)	Creates a new property.
static <T> @NotNull AdventureProperties.Property<T>	property(@NotNull String name, @NotNull Function<String,T> parser, T defaultValue, boolean allowProviderDefaultOverride)	Creates a new property.

Methods inherited from class java.lang.Object

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

Field Details

DEBUG

public static final AdventureProperties.Property<Boolean> DEBUG

Property for specifying whether debug mode is enabled.

Since:

4.10.0

DEFAULT_TRANSLATION_LOCALE

public static final AdventureProperties.Property<String> DEFAULT_TRANSLATION_LOCALE

Property for specifying the default translation locale.

Since:

4.10.0

SERVICE_LOAD_FAILURES_ARE_FATAL

public static final AdventureProperties.Property<Boolean> SERVICE_LOAD_FAILURES_ARE_FATAL

Property for specifying whether service load failures are fatal.

Since:

4.10.0

TEXT_WARN_WHEN_LEGACY_FORMATTING_DETECTED

public static final AdventureProperties.Property<Boolean> TEXT_WARN_WHEN_LEGACY_FORMATTING_DETECTED

Property for specifying whether to warn when legacy formatting is detected.

Since:

4.10.0

DEFAULT_FLATTENER_NESTING_LIMIT

public static final AdventureProperties.Property<Integer> DEFAULT_FLATTENER_NESTING_LIMIT

Property for setting a global default for flattener nesting.

Since:

4.24.0

Method Details

property

@NotNull
public static <T>
@NotNull AdventureProperties.Property<T> property(@NotNull
 @NotNull String name,
 @NotNull
 @NotNull Function<String,T> parser,
 @Nullable
 T defaultValue)

Creates a new property.

Type Parameters:

T - the value type

Parameters:

name - the property name

parser - the value parser

defaultValue - the default value

Returns:

a property

Since:

4.10.0

property

@NotNull
public static <T>
@NotNull AdventureProperties.Property<T> property(@NotNull
 @NotNull String name,
 @NotNull
 @NotNull Function<String,T> parser,
 @Nullable
 T defaultValue,
 boolean allowProviderDefaultOverride)

Creates a new property.

Type Parameters:

T - the value type

Parameters:

name - the property name

parser - the value parser

defaultValue - the default value

allowProviderDefaultOverride - if the AdventureProperties.DefaultOverrideProvider is used to override the default value provided

Returns:

a property

Since:

4.24.0