Class in Yarn.Unity

Inherits from UnityEngine.ScriptableObject

Summary

public class Localization : ScriptableObject

Methods

Properties

Method in

Summary

Parameters

Method in

Summary

Method in

Summary

Parameters

Method in

Summary

Parameters

Method in

Summary

Gets the line IDs present in this localization.

Remarks

The line IDs can be used to access the localized text or asset associated with a line.

Returns

The line IDs.

Method in Localization

Summary

Adds a collection of strings to the runtime string table.

public void AddLocalizedStrings(IEnumerable<StringTableEntry> stringTableEntries)

Remarks

This method updates the localisation's runtime string table, which is useful for adding or changing the localisation during gameplay or in a built player. It doesn't modify the asset on disk, and any changes made will be lost when gameplay ends.

Parameters

Method in Localization

Summary

public void SetLocalizedObject<T>(string key, T value) where T : UnityEngine.Object;

Parameters

Property in Localization

Summary

Gets a value indicating whether this Localization contains assets that are linked to strings.

public bool ContainsLocalizedAssets { get; internal set; }

Property in Localization

Summary

public string LocaleCode { get; set; }

Method in Localization

Summary

Returns a boolean value indicating whether this Localization contains a string with the given key.

public bool ContainsLocalizedString(string key);

Parameters

Returns

true if this Localization has a string for the given key; false otherwise.

Method in Localization

Summary

public T GetLocalizedObject<T>(string key) where T : UnityEngine.Object

Parameters

Method in Localization

Summary

public string GetLocalizedString(string key)

Parameters

Property in Localization

Summary

Gets a value indicating whether this Localization makes use of Addressable Assets ( true ), or if it stores its assets as direct references ( false ).

public bool UsesAddressableAssets { get; internal set; }

Remarks

If this property is true , Yarn.Unity.Localization.GetLocalizedObject1(System.String)</code> and <code>Yarn.Unity.Localization.ContainsLocalizedObject1(System.String) should not be used to retrieve localised objects. Instead, the Addressable Assets API should be used.

Method in Localization

Summary

Adds a new string to the runtime string table.

public void AddLocalizedString(string key, string value)

Remarks

This method updates the localisation's runtime string table, which is useful for adding or changing the localisation during gameplay or in a built player. It doesn't modify the asset on disk, and any changes made will be lost when gameplay ends.

Parameters

Method in Localization

Summary

Adds a collection of strings to the runtime string table.

public void AddLocalizedStrings(IEnumerable<KeyValuePair<string, string>> strings)

Remarks

This method updates the localisation's runtime string table, which is useful for adding or changing the localisation during gameplay or in a built player. It doesn't modify the asset on disk, and any changes made will be lost when gameplay ends.

Parameters