DisplayName(String value, translatable=false): The display name of a metadata holder. Applicable to configs, sections, and fields. Metadata processors (like config screens) may define generated translation keys taking precedence if it isn't translatable. If translatable is true, the value should be treated as a translation key
DisplayNameConvention(DefaultNamingSchemes value, custom=""): The naming scheme used to derive the fallback display names of the metadata holder for config screens. DisplayName must take precedence, metadata processors (like config screens) may define generated translation keys taking precedence over DisplayNameConvention. Inheritable and applicable to configs, sections, and fields
ChangeWarning(metdata.ChangeWarning.Type value, customMessage=""): Used to tell config screen libraries that a warning should be displayed before applying changes. The type can be RequiresRestart, Unsafe, Experimental, CustomTranslatable, or Custom. If it is CustomTranslatable, customMessage is used as a translation key. If it is Custom, customMessage is used as the raw message, but the metdata provider may define translation keys that take precedence.
DisplayName(String value, translatable=false)
: The display name of a metadata holder. Applicable to configs, sections, and fields. Metadata processors (like config screens) may define generated translation keys taking precedence if it isn't translatable. If translatable is true, the value should be treated as a translation keyDisplayNameConvention(DefaultNamingSchemes value, custom="")
: The naming scheme used to derive the fallback display names of the metadata holder for config screens.DisplayName
must take precedence, metadata processors (like config screens) may define generated translation keys taking precedence overDisplayNameConvention
. Inheritable and applicable to configs, sections, and fieldsChangeWarning(metdata.ChangeWarning.Type value, customMessage="")
: Used to tell config screen libraries that a warning should be displayed before applying changes. The type can beRequiresRestart
,Unsafe
,Experimental
,CustomTranslatable
, orCustom
. If it isCustomTranslatable
,customMessage
is used as a translation key. If it isCustom
,customMessage
is used as the raw message, but the metdata provider may define translation keys that take precedence.Fixes #31, fixes #30