Click or drag to resize

LocalizationLoader Class

A utility class to localize the annotated members
Inheritance Hierarchy
SystemObject
  Object
    Component
      Behaviour
        MonoBehaviour
          KSPDev.GUIUtilsLocalizationLoader

Namespace:  KSPDev.GUIUtils
Assembly:  KSPDev_Utils.2.0 (in KSPDev_Utils.2.0.dll) Version: 2.0 for KSP v1.8+
Syntax
C#
Copy
public class LocalizationLoader : MonoBehaviour
Request Example View Source

The LocalizationLoader type exposes the following members.

Constructors
  NameDescription
Public methodLocalizationLoader
Initializes a new instance of the LocalizationLoader class
Top
Methods
  NameDescription
Public methodStatic memberCode exampleLoadItemsInModule
Localizes the PartModule items.
Top
Remarks

It also monitors if the localization version has changed. If this is the case, then all the localizable modules will be notified.

This module is initialized from the KSPDev Utils loader.

Examples
Copy
public class LocalizationLoaderDemo1 : PartModule {
  public class OtherModule : PartModule {
    [KSPField(guiName = "just-in-case text", guiActive = true)]
    [LocalizableItem(tag = "#tag1")]
    public string field1 = "";
  }

  public void AddCustomModule() {
    var newModule = gameObject.AddComponent<OtherModule>();
    LocalizationLoader.LoadItemsInModule(newModule);
  }
}
Examples
Copy
public class LocalizationLoaderDemo2 : PartModule, IsLocalizableModule {
  [KSPField(guiActive = true)]
  [LocalizableItem(tag = "#tag1", defaultTemplate = "Field1")]
  [LocalizableItem(tag = "#tag2", defaultTemplate = "units",
                   spec = StdSpecTags.Units)]
  public string field1 = "";

-  #region IsLocalizableModule implementation
   public void LocalizeModule() {
     LocalizationLoader.LoadItemsInModule(this);
   }
   #endregion

  public override void OnAwake() {
    base.OnAwake();
    LocalizeModule();
  }
}
See Also