Skip to content

BasicUsage.md

Latest commit

 

History

History
57 lines (39 loc) · 2.75 KB

BasicUsage.md

File metadata and controls

57 lines (39 loc) · 2.75 KB
Raw

Basic Usage

Contents

Localised objects/components

With localised components you may need to ensure that the schema is set and that the tables were refreshed before you will be able to configure it. See also

There are 3 LocalisedObjects that come ready to use, They are LocalisedText, LocalisedImage, and LocalisedAudio. They work in conjunction with Text, Image and AudioSource respectively.

To configure it add the base component (Text, Image or AudioSource), then add the localised component counterpart

Set the category and the key.

The audio/image components treat the the localised string as a resource path and it will attempt to load the correct components.

LocalisedText

Format paramters can also be specified in the same way as string.format(). If the localised value contains variables embedded in the strings.

Example Pickup the {0}sword{1}. In this case the format parameters for 0 and 1 could be rich text tags to make sword show up in bold and in another colour.

Retrieving a localised string in code

Localiser.GetLocalisedString(Keys.MainMenu.MainMenuTitle);

Change language at runtime

Localiser.SwitchLocale("fr"); // switch to French

This will automatically update any localisation-sensitive components.

Extending AbstractLocalisedObject

In some situations you may want to set the text, sprite, or audio on a different component other than Text, Image or AudioSource.

For example you may want to set the text on a TextMeshPro object. To accomplish this just extend AbstractLocalisedObject and make the relevant changes.

eg:

[RequireComponent(typeof(TextMeshProUGUI))]
public class LocalisedText : AbstractLocalisedObject<TextMeshProUGUI>
{
    // Called whenever locale changes (and when the component awakes)
    protected override void HandleLocaleChanged(bool translationFound, string localisedString)
    {
        Component.text = translationFound ? localisedString : $"<color=red>{localisationKey}</color>";
    }
}

Above we specified the type parameter TextMeshProUGUI when inheriting AbstractLocalisedObject<>. This specifies the type of component that this localiser component will accompany and is used to obtain a reference to it which is accessible through the Component property.

Note: we cannot provide this as part of the package without introducing a dependency on the TextMeshPro assembly, otherwise we would ship this library with this component.