EnumTranslatable

SubInterface of Translatable for use with Enums

If a non-Enum extends this, the game will crash

The default translationKey will be in the form "<prefix>.CONSTANT". Example: TestEnum.TEST

The default descriptionKey will be in the form "<prefix>.CONSTANT.desc". Example: TestEnum.TEST.desc

The default prefixKey will be in the form "<prefix>.CONSTANT.prefix". Example: TestEnum.TEST.prefix

fzzyhmstrs

0.2.0

Functions

open fun description(fallback: String? = null): MutableText

The translated Text description from the descriptionKey. Falls back to an empty string so no tooltip is rendered.

open override fun descriptionKey(): String

Override of descriptionKey that utilized the prefix and enum constant name

Whether this Translatable has a valid description

Whether this Translatable has a valid prefix

Whether this Translatable has a valid translation

open fun prefix(): String

Defines the prefix of the translation/description key

open fun prefix(fallback: String? = null): MutableText

The translated Text description from the descriptionKey. Falls back to an empty string so no tooltip is rendered.

open override fun prefixKey(): String

Override of descriptionKey that utilized the prefix and enum constant name

open override fun translation(fallback: String?): MutableText

Override of translation that falls back to the enum constant name. Example "TEST"

open override fun translationKey(): String

Override of translationKey that utilized the prefix and enum constant name