Package xaero.pac.client.player.config.api.v2

Interface IPlayerConfigStringableOptionClientStorageAPI<T>

All Superinterfaces:

IPlayerConfigOptionClientStorageAPI<T>

public interface IPlayerConfigStringableOptionClientStorageAPI<T>
extends IPlayerConfigOptionClientStorageAPI<T>

API for a stringable player config option value storage on the client side

Method Summary

Modifier and Type	Method	Description
Function<String,T>	getCommandInputParser()	Gets the string input parser for this option.
String	getComment()	Gets the default comment text for the option.
Function<Object,net.minecraft.network.chat.Component>	getComponentWriterCast()	Gets the component output writer for this option.
String	getId()	Gets the option string ID.
IPlayerConfigOptionSpecAPI<T>	getOption()	Gets the option spec that this storage holds the value for.
BiPredicate<IPlayerConfigClientStorageAPI,String>	getStringValidator()	Gets the string value input validator for this option.
String	getTooltipPrefix()	Gets the text prefix for the option tooltip on the UI screens.
String	getTranslation()	Gets the translation key for the name of the option.
Class<T>	getType()	Gets the type of the option value that this storage holds.
BiPredicate<IPlayerConfigClientStorageAPI,T>	getValidator()	Gets the option value validator that checks whether a certain value is valid for the option.
T	getValue()	Gets the stored option value.
boolean	isDefaulted()	Checks whether this option is forced to its default player config value.
boolean	isMutable()	Checks whether the local client player can edit this option's value, taking permissions into account.

Methods inherited from interface xaero.pac.client.player.config.api.v2.IPlayerConfigOptionClientStorageAPI

getCommentTranslation, getCommentTranslationArgs, getTranslationArgs, isAdminMutable, isPlayerMutable

Method Details

getOption

@Nonnull
IPlayerConfigOptionSpecAPI<T> getOption()

Description copied from interface: IPlayerConfigOptionClientStorageAPI

Gets the option spec that this storage holds the value for.

Specified by:

getOption in interface IPlayerConfigOptionClientStorageAPI<T>

Returns:

the option spec of this storage, not null

getId

@Nonnull
String getId()

Description copied from interface: IPlayerConfigOptionClientStorageAPI

Gets the option string ID.

Specified by:

getId in interface IPlayerConfigOptionClientStorageAPI<T>

Returns:

the option string ID, not null

getComment

@Nonnull
String getComment()

Description copied from interface: IPlayerConfigOptionClientStorageAPI

Gets the default comment text for the option.

Specified by:

getComment in interface IPlayerConfigOptionClientStorageAPI<T>

Returns:

the default comment text, not null

getTranslation

@Nonnull
String getTranslation()

Description copied from interface: IPlayerConfigOptionClientStorageAPI

Gets the translation key for the name of the option.

Specified by:

getTranslation in interface IPlayerConfigOptionClientStorageAPI<T>

Returns:

translation key for the name of the option, not null

getType

@Nonnull
Class<T> getType()

Description copied from interface: IPlayerConfigOptionClientStorageAPI

Gets the type of the option value that this storage holds.

Specified by:

getType in interface IPlayerConfigOptionClientStorageAPI<T>

Returns:

the type of the option value, not null

getValue

@Nullable
T getValue()

Description copied from interface: IPlayerConfigOptionClientStorageAPI

Gets the stored option value.

Specified by:

getValue in interface IPlayerConfigOptionClientStorageAPI<T>

Returns:

the stored value

getValidator

@Nonnull
BiPredicate<IPlayerConfigClientStorageAPI,T> getValidator()

Description copied from interface: IPlayerConfigOptionClientStorageAPI

Gets the option value validator that checks whether a certain value is valid for the option.

Specified by:

getValidator in interface IPlayerConfigOptionClientStorageAPI<T>

Returns:

the option value validator, not null

getTooltipPrefix

@Nullable
String getTooltipPrefix()

Description copied from interface: IPlayerConfigOptionClientStorageAPI

Gets the text prefix for the option tooltip on the UI screens.

Specified by:

getTooltipPrefix in interface IPlayerConfigOptionClientStorageAPI<T>

Returns:

the tooltip prefix, null if there is none

isDefaulted

boolean isDefaulted()

Description copied from interface: IPlayerConfigOptionClientStorageAPI

Checks whether this option is forced to its default player config value.

Specified by:

isDefaulted in interface IPlayerConfigOptionClientStorageAPI<T>

Returns:

true if the option value is defaulted, otherwise false

isMutable

boolean isMutable()

Description copied from interface: IPlayerConfigOptionClientStorageAPI

Checks whether the local client player can edit this option's value, taking permissions into account.

Specified by:

isMutable in interface IPlayerConfigOptionClientStorageAPI<T>

Returns:

true if the option value is mutable, otherwise false

getCommandInputParser

@Nonnull
Function<String,T> getCommandInputParser()

Gets the string input parser for this option.

It is the same one that is used for parsing command inputs.

Returns:

the string input parser function, not null

getComponentWriterCast

@Nonnull
Function<Object,net.minecraft.network.chat.Component> getComponentWriterCast()

Gets the component output writer for this option.

It is the same one that is used for displaying option values in command outputs.

It accepts values of any type but will only work with the right one.

Returns:

the component output writer function, not null

getStringValidator

@Nonnull
BiPredicate<IPlayerConfigClientStorageAPI,String> getStringValidator()

Gets the string value input validator for this option.

Returns:

the string value input validator function, not null