LocalizableMessage Constructor |
Constructs a localizable message.
Namespace:
KSPDev.GUIUtils
Assembly:
KSPDev_Utils.2.0 (in KSPDev_Utils.2.0.dll) Version: 2.0 for KSP v1.8+
Syntaxprotected LocalizableMessage(
string tag,
string defaultTemplate = null,
string description = null,
string example = null
)
Request Example
View SourceParameters
- tag
- Type: SystemString
The tag to use when getting the localized version of the template. If null then the
message will alaways use defaultTemplate as text.
- defaultTemplate (Optional)
- Type: SystemString
The template to use if no localizable content can be found. It can be in any language, but
it's strongly encouraged to put it in English. For the template syntax see the documentation
on the Lingoona website.
If this parameter is omitted, then the tag will be used as a default
template. I.e. in case of the tag lookup failed, the tag string will be presented instead of
a human readable string.
- description (Optional)
- Type: SystemString
A helper text for the translators to give them a context. Try to be reasonably verbose when
specifying the circumstances of when this string is displayed. The context does matter!
- example (Optional)
- Type: SystemString
An example of how the template can be used and what is the output in the langauge of the
defaultTemplate. Provide it to illustrate the non-obvious cases.
See Also