Interface IPlayerConfigOptionClientStorageAPI<T extends Comparable<T>>
- All Known Subinterfaces:
IPlayerConfigStringableOptionClientStorageAPI<T>
-
Method Summary
Modifier and TypeMethodDescriptionDeprecated.useIPlayerConfigOptionClientStorageAPIinsteadDeprecated.useIPlayerConfigOptionClientStorageAPIinsteadObject[]Deprecated.useIPlayerConfigOptionClientStorageAPIinsteadgetId()Deprecated.useIPlayerConfigOptionClientStorageAPIinsteadDeprecated.useIPlayerConfigOptionClientStorageAPIinsteadDeprecated.useIPlayerConfigOptionClientStorageAPIinsteadDeprecated.useIPlayerConfigOptionClientStorageAPIinsteadObject[]Deprecated.useIPlayerConfigOptionClientStorageAPIinsteadgetType()Deprecated.useIPlayerConfigOptionClientStorageAPIinsteadDeprecated.useIPlayerConfigOptionClientStorageAPIinsteadgetValue()Deprecated.useIPlayerConfigOptionClientStorageAPIinsteadbooleanDeprecated.useIPlayerConfigOptionClientStorageAPIinsteadbooleanDeprecated.useIPlayerConfigOptionClientStorageAPIinstead
-
Method Details
-
getOption
Deprecated.useIPlayerConfigOptionClientStorageAPIinsteadGets the option spec that this storage holds the value for.
- Returns:
- the option spec of this storage, not null
-
getId
Deprecated.useIPlayerConfigOptionClientStorageAPIinsteadGets the option string ID.
- Returns:
- the option string ID, not null
-
getComment
Deprecated.useIPlayerConfigOptionClientStorageAPIinsteadGets the default comment text for the option.
- Returns:
- the default comment text, not null
-
getTranslation
Deprecated.useIPlayerConfigOptionClientStorageAPIinsteadGets the translation key for the name of the option.
- Returns:
- translation key for the name of the option, not null
-
getTranslationArgs
Deprecated.useIPlayerConfigOptionClientStorageAPIinsteadGets the translation key arguments for the name of this option.
- Returns:
- the translation key arguments, not null
-
getCommentTranslation
Deprecated.useIPlayerConfigOptionClientStorageAPIinsteadGets the translation key for the comment of this option.
- Returns:
- the comment translation key, not null
-
getCommentTranslationArgs
Deprecated.useIPlayerConfigOptionClientStorageAPIinsteadGets the translation key arguments for the comment of this option.
- Returns:
- the comment translation key arguments, not null
-
getType
Deprecated.useIPlayerConfigOptionClientStorageAPIinsteadGets the type of the option value that this storage holds.
- Returns:
- the type of the option value, not null
-
getValue
Deprecated.useIPlayerConfigOptionClientStorageAPIinsteadGets the stored option value.
- Returns:
- the stored value
-
getValidator
Deprecated.useIPlayerConfigOptionClientStorageAPIinsteadGets the option value validator that checks whether a certain value is valid for the option.
- Returns:
- the option value validator, not null
-
getTooltipPrefix
Deprecated.useIPlayerConfigOptionClientStorageAPIinsteadGets the text prefix for the option tooltip on the UI screens.
- Returns:
- the tooltip prefix, null if there is none
-
isDefaulted
Deprecated.useIPlayerConfigOptionClientStorageAPIinsteadChecks whether this option is forced to its default player config value.
- Returns:
- true if the option value is defaulted, otherwise false
-
isMutable
Deprecated.useIPlayerConfigOptionClientStorageAPIinsteadChecks whether the local client player can edit this option's value.
- Returns:
- true if the option value is mutable, otherwise false
-
IPlayerConfigOptionClientStorageAPIinstead