Class PropertyContainer | Package Manager UI website
docs.unity3d.com
    Show / Hide Table of Contents

    Class PropertyContainer

    Inheritance
    System.Object
    PropertyContainer
    Namespace: Unity.Properties
    Syntax
    public static class PropertyContainer

    Methods

    GetValue<TContainer, TValue>(ref TContainer, String)

    Gets the value of the property with the given name for the given container.

    Declaration
    public static TValue GetValue<TContainer, TValue>(ref TContainer container, string name)
    Parameters
    Type Name Description
    TContainer container

    The container hosting the data.

    System.String name

    The property name to get.

    Returns
    Type Description
    TValue

    The value of the property converted to the given type.

    Type Parameters
    Name Description
    TContainer
    TValue

    SetValue<TContainer, TValue>(ref TContainer, String, TValue, ref ChangeTracker)

    Sets the value of the property with the given name for the given container.

    Declaration
    public static void SetValue<TContainer, TValue>(ref TContainer container, string name, TValue value, ref ChangeTracker changeTracker)
    Parameters
    Type Name Description
    TContainer container

    The container whose data will be set.

    System.String name

    The property name to set.

    TValue value

    The value to assign to the property.

    ChangeTracker changeTracker

    The change tracker to increment if the value changes.

    Type Parameters
    Name Description
    TContainer
    TValue

    SetValue<TContainer, TValue>(ref TContainer, String, TValue, IVersionStorage)

    Sets the value of the property with the given name for the given container.

    Declaration
    public static void SetValue<TContainer, TValue>(ref TContainer container, string name, TValue value, IVersionStorage versionStorage = null)
    Parameters
    Type Name Description
    TContainer container

    The container whose data will be set.

    System.String name

    The property name to set.

    TValue value

    The value to assign to the property.

    IVersionStorage versionStorage

    The version storage to increment if the value is changed.

    Type Parameters
    Name Description
    TContainer
    TValue

    Transfer<TDestination, TSource>(TDestination, TSource, IVersionStorage)

    Declaration
    public static void Transfer<TDestination, TSource>(TDestination destination, TSource source, IVersionStorage versionStorage = null)
        where TDestination : class
    Parameters
    Type Name Description
    TDestination destination
    TSource source
    IVersionStorage versionStorage
    Type Parameters
    Name Description
    TDestination
    TSource

    Transfer<TDestination, TSource>(ref TDestination, ref TSource, ref ChangeTracker)

    Declaration
    public static void Transfer<TDestination, TSource>(ref TDestination destination, ref TSource source, ref ChangeTracker changeTracker)
    Parameters
    Type Name Description
    TDestination destination
    TSource source
    ChangeTracker changeTracker
    Type Parameters
    Name Description
    TDestination
    TSource

    Transfer<TDestination, TSource>(ref TDestination, ref TSource, IVersionStorage)

    Declaration
    public static void Transfer<TDestination, TSource>(ref TDestination destination, ref TSource source, IVersionStorage versionStorage = null)
    Parameters
    Type Name Description
    TDestination destination
    TSource source
    IVersionStorage versionStorage
    Type Parameters
    Name Description
    TDestination
    TSource

    TryGetValue<TContainer, TValue>(ref TContainer, String, out TValue)

    Gets the value of the property with the given name for the given container.

    Declaration
    public static bool TryGetValue<TContainer, TValue>(ref TContainer container, string name, out TValue value)
    Parameters
    Type Name Description
    TContainer container

    The container hosting the data.

    System.String name

    The property name to get.

    TValue value

    Contains the value if the property is found and the type can be converted; otherwise this is set to default.

    Returns
    Type Description
    System.Boolean

    True if the property was found and the value was converted.

    Type Parameters
    Name Description
    TContainer
    TValue

    TrySetValue<TContainer, TValue>(ref TContainer, String, TValue, ref ChangeTracker)

    Sets the value of the property with the given name for the given container.

    Declaration
    public static bool TrySetValue<TContainer, TValue>(ref TContainer container, string name, TValue value, ref ChangeTracker changeTracker)
    Parameters
    Type Name Description
    TContainer container

    The container hosting the data.

    System.String name

    The property name to set.

    TValue value

    The value to assign to the property.

    ChangeTracker changeTracker

    The change tracker to increment if the value changes.

    Returns
    Type Description
    System.Boolean

    True if the property was found and the value was set.

    Type Parameters
    Name Description
    TContainer
    TValue

    TrySetValue<TContainer, TValue>(ref TContainer, String, TValue, IVersionStorage)

    Sets the value of the property with the given name for the given container.

    Declaration
    public static bool TrySetValue<TContainer, TValue>(ref TContainer container, string name, TValue value, IVersionStorage versionStorage = null)
    Parameters
    Type Name Description
    TContainer container

    The container hosting the data.

    System.String name

    The property name to set.

    TValue value

    The value to assign to the property.

    IVersionStorage versionStorage

    The version storage to increment if the value is changed.

    Returns
    Type Description
    System.Boolean

    True if the property was found and the value was set.

    Type Parameters
    Name Description
    TContainer
    TValue

    Visit<TContainer, TVisitor>(TContainer, TVisitor, IVersionStorage)

    Declaration
    public static void Visit<TContainer, TVisitor>(TContainer container, TVisitor visitor, IVersionStorage versionStorage = null)
        where TVisitor : IPropertyVisitor
    Parameters
    Type Name Description
    TContainer container
    TVisitor visitor
    IVersionStorage versionStorage
    Type Parameters
    Name Description
    TContainer
    TVisitor

    Visit<TContainer, TVisitor>(ref TContainer, TVisitor, ref ChangeTracker)

    Declaration
    public static void Visit<TContainer, TVisitor>(ref TContainer container, TVisitor visitor, ref ChangeTracker changeTracker)
        where TVisitor : IPropertyVisitor
    Parameters
    Type Name Description
    TContainer container
    TVisitor visitor
    ChangeTracker changeTracker
    Type Parameters
    Name Description
    TContainer
    TVisitor

    Visit<TContainer, TVisitor>(ref TContainer, TVisitor, IVersionStorage)

    Declaration
    public static void Visit<TContainer, TVisitor>(ref TContainer container, TVisitor visitor, IVersionStorage versionStorage = null)
        where TVisitor : IPropertyVisitor
    Parameters
    Type Name Description
    TContainer container
    TVisitor visitor
    IVersionStorage versionStorage
    Type Parameters
    Name Description
    TContainer
    TVisitor
    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