Package org.skriptlang.skript.lang.entry.util

Class VariableStringEntryData

java.lang.Object

org.skriptlang.skript.lang.entry.EntryData<T>

org.skriptlang.skript.lang.entry.KeyValueEntryData<VariableString>

org.skriptlang.skript.lang.entry.util.VariableStringEntryData

public class VariableStringEntryData
extends KeyValueEntryData<VariableString>

A type of KeyValueEntryData designed to parse its value as a VariableString. The StringMode may be specified during construction. Constructors without a StringMode parameter assume StringMode.MESSAGE. This data CAN return null if string parsing fails (e.g. the user formatted their string wrong).

Constructor Summary

Constructors

Constructor	Description
VariableStringEntryData(String key, @Nullable VariableString defaultValue, boolean optional)	Uses StringMode.MESSAGE as the default string mode.
VariableStringEntryData(String key, @Nullable VariableString defaultValue, boolean optional, StringMode stringMode)

Method Summary

Modifier and Type	Method	Description
protected @Nullable VariableString	getValue(String value)	Parses a String value using this entry data.

Methods inherited from class org.skriptlang.skript.lang.entry.KeyValueEntryData

canCreateWith, getSeparator, getValue

Methods inherited from class org.skriptlang.skript.lang.entry.EntryData

getDefaultValue, getKey, isOptional

Methods inherited from class java.lang.Object

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

Constructor Details

VariableStringEntryData

public VariableStringEntryData(String key,
 @Nullable VariableString defaultValue,
 boolean optional)

Uses StringMode.MESSAGE as the default string mode.

See Also:

• VariableStringEntryData(String, VariableString, boolean, StringMode)

VariableStringEntryData

public VariableStringEntryData(String key,
 @Nullable VariableString defaultValue,
 boolean optional,
 StringMode stringMode)

Parameters:

stringMode - Sets how to parse the string (e.g. as a variable, message, etc.).

Method Details

getValue

protected @Nullable VariableString getValue(String value)

Description copied from class: KeyValueEntryData

Parses a String value using this entry data.

Specified by:

getValue in class KeyValueEntryData<VariableString>

Parameters:

value - The String value to parse.

Returns:

The parsed value.