docs.unity3d.com
    Show / Hide Table of Contents

    Class LocalizableString

    A serializable string that is localized at run-time.

    Inheritance
    Object
    LocalizableString
    Namespace: Unity.InteractiveTutorials
    Syntax
    [Serializable]
    public class LocalizableString : ISerializationCallbackReceiver

    Constructors

    LocalizableString()

    Default-constructs with empty strings.

    Declaration
    public LocalizableString()

    LocalizableString(String)

    Constructs with an untranslated string.

    Declaration
    public LocalizableString(string untranslated)
    Parameters
    Type Name Description
    String untranslated

    Fields

    OldPropertyPath

    TODO 2.0 make internal

    Declaration
    public const string OldPropertyPath = "<Untranslated>k__BackingField"
    Field Value
    Type Description
    String

    PropertyPath

    TODO 2.0 make internal

    Declaration
    public const string PropertyPath = "m_Untranslated"
    Field Value
    Type Description
    String

    Properties

    Translated

    The localized strings, if it exists.

    Declaration
    public string Translated { get; set; }
    Property Value
    Type Description
    String

    Untranslated

    Setting Untranslated string overwrites Translated so make sure to translate again.

    Declaration
    public string Untranslated { get; set; }
    Property Value
    Type Description
    String

    Value

    The translated string, if exists, untranslated otherwise.

    Declaration
    public string Value { get; }
    Property Value
    Type Description
    String

    Methods

    OnAfterDeserialize()

    UnityEngine.ISerializationCallbackReceiver override, do not call.

    Declaration
    public void OnAfterDeserialize()
    Implements
    ISerializationCallbackReceiver.OnAfterDeserialize()

    OnBeforeSerialize()

    UnityEngine.ISerializationCallbackReceiver override, do not call.

    Declaration
    public void OnBeforeSerialize()
    Implements
    ISerializationCallbackReceiver.OnBeforeSerialize()

    Operators

    Implicit(String to LocalizableString)

    Implicitly constructs from an untranslated string.

    Declaration
    public static implicit operator LocalizableString(string untranslated)
    Parameters
    Type Name Description
    String untranslated
    Returns
    Type Description
    LocalizableString

    Implicit(LocalizableString to String)

    Implicit conversion to string returns the Value.

    Declaration
    public static implicit operator string (LocalizableString str)
    Parameters
    Type Name Description
    LocalizableString str
    Returns
    Type Description
    String
    Back to top
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023