docs.unity.cn
    Show / Hide Table of Contents

    Interface ITrackedPropertyValue<T>

    Interface for accessing a tracked property`s values.

    Inherited Members
    ITrackedProperty.PropertyPath
    ITrackedProperty.HasVariant(LocaleIdentifier)
    Namespace: UnityEngine.Localization.PropertyVariants.TrackedProperties
    Syntax
    public interface ITrackedPropertyValue<T> : ITrackedProperty
    Type Parameters
    Name Description
    T

    The property data type.

    Methods

    GetValue(LocaleIdentifier, out T)

    Attempts to find a value for the provided LocaleIdentifier.

    Declaration
    bool GetValue(LocaleIdentifier localeIdentifier, out T foundValue)
    Parameters
    Type Name Description
    LocaleIdentifier localeIdentifier

    The LocaleIdentifier to check for.

    T foundValue

    The value found for the LocaleIdentifier.

    Returns
    Type Description
    Boolean

    True if a value was found and false if one was not.

    GetValue(LocaleIdentifier, LocaleIdentifier, out T)

    Attempts to find a value for the provided LocaleIdentifier or fallback.

    Declaration
    bool GetValue(LocaleIdentifier localeIdentifier, LocaleIdentifier fallback, out T foundValue)
    Parameters
    Type Name Description
    LocaleIdentifier localeIdentifier

    The LocaleIdentifier to check for.

    LocaleIdentifier fallback

    The LocaleIdentifier to fallback to if one could not be found for localeIdentifier.

    T foundValue

    The value found for the LocaleIdentifier or fallback.

    Returns
    Type Description
    Boolean

    True if a value was found and false if one was not.

    SetValue(LocaleIdentifier, T)

    Assigns a value for the chosen LocaleIdentifier.

    Declaration
    void SetValue(LocaleIdentifier localeIdentifier, T value)
    Parameters
    Type Name Description
    LocaleIdentifier localeIdentifier

    The LocaleIdentifier the variant should be applied to

    T value

    The variant value for the LocaleIdentifier.

    Back to top Copyright © 2022 Unity Technologies
    Generated by DocFX
    on Thursday, June 9, 2022
    Terms of use