LocalizableMessage Class |
Inheritance HierarchyNamespace: KSPDev.GUIUtils
Assembly: KSPDev_Utils.2.0 (in KSPDev_Utils.2.0.dll) Version: 2.0 for KSP v1.8+
SyntaxThe LocalizableMessage type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | LocalizableMessage | Constructs a localizable message. |
Properties| Name | Description | |
|---|---|---|
 | localizedTemplate | Localized Lingoona Grammar template for the tag. |
Methods| Name | Description | |
|---|---|---|
 | LoadLocalization | Instructs the implementation to load a localized template. |
Fields| Name | Description | |
|---|---|---|
 | defaultTemplate | Template to use if no localized template found. |
| description | Description for the message. |
| example | Example usage and the output. |
| guiTags | GUI specific settings that suggest how to show the message. |
 | loadedLocVersion | Currently cached version of the localization content. |
 | systemLocVersion | Current version of the loaded localizations. |
| tag | Tag to use when resolving the string via the Localizer. |
RemarksThis class is not intended for the use on its own. See the inheritance hierarchy for the classes that inherit it.
This class is performance optimized. Once a string is resolved to the localized content, it's cached and reused in the subsequent calls. The cache can be reset by incrementing the systemLocVersion.
The template of the messages supports special tags that may give a hint to the caller code on how the messages should be rendered. Those tags must be palced at the beginning of the template. For the available tags see LocalizableMessageGuiTags.
See AlsoReference
Inheritance HierarchyKSPDev.GUIUtilsLocalizableMessage
KSPDev.GUIUtilsMessage
KSPDev.GUIUtilsMessageT1
KSPDev.GUIUtilsMessageT1, T2
KSPDev.GUIUtilsMessageT1, T2, T3
KSPDev.GUIUtilsMessageT1, T2, T3, T4
KSPDev.GUIUtilsMessageT1, T2, T3, T4, T5