Class PropertyVisitExtensions | Properties | 1.1.1-preview
docs.unity3d.com
    Show / Hide Table of Contents

    Class PropertyVisitExtensions

    A set of property extension methods for visitation.

    Inheritance
    Object
    PropertyVisitExtensions
    Namespace: Unity.Properties
    Syntax
    public static class PropertyVisitExtensions

    Methods

    Visit<TValue>(IProperty, PropertyVisitor, ref TValue)

    Call this method to net visit all the elements of the given value.

    Declaration
    public static void Visit<TValue>(this IProperty property, PropertyVisitor visitor, ref TValue value)
    Parameters
    Type Name Description
    IProperty property
    PropertyVisitor visitor

    The property visitor to use.

    TValue value

    The value to visit.

    Type Parameters
    Name Description
    TValue

    The value type for this property.

    Visit<TValue>(IProperty, PropertyVisitor, ref TValue, Int32)

    Visits a specific element of the given container by index.

    Declaration
    public static void Visit<TValue>(this IProperty property, PropertyVisitor visitor, ref TValue container, int index)
    Parameters
    Type Name Description
    IProperty property

    The property this method extends.

    PropertyVisitor visitor

    The visitor to use.

    TValue container

    The container to visit.

    Int32 index

    The index to visit at.

    Type Parameters
    Name Description
    TValue

    The value type for this property.

    Remarks

    This method can be used to selectively visit list elements while maintaining the visit context.

    Exceptions
    Type Condition
    IndexOutOfRangeException

    The given index could not be resolved.

    InvalidOperationException

    The given container is not indexable.

    Visit<TValue>(IProperty, PropertyVisitor, ref TValue, Object)

    Visits a specific element of the given container by key.

    Declaration
    public static void Visit<TValue>(this IProperty property, PropertyVisitor visitor, ref TValue container, object key)
    Parameters
    Type Name Description
    IProperty property

    The property this method extends.

    PropertyVisitor visitor

    The visitor to use.

    TValue container

    The container to visit.

    Object key

    The key to visit at.

    Type Parameters
    Name Description
    TValue

    The value type for this property.

    Remarks

    This method can be used to selectively visit dictionary elements while maintaining the visit context.

    Exceptions
    Type Condition
    IndexOutOfRangeException

    The given index could not be resolved.

    InvalidOperationException

    The given container is not indexable.

    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