docs.unity3d.com
    Show / Hide Table of Contents

    Method ToComponentDataArray

    ToComponentDataArray<T>(Allocator)

    Creates a NativeArray containing the components of type T for the selected entities.

    Declaration
    [BurstCompatible(GenericTypeArguments = new Type[]{typeof(BurstCompatibleComponentData)})]
    public NativeArray<T> ToComponentDataArray<T>(Allocator allocator)
        where T : struct, IComponentData
    Parameters
    Type Name Description
    Allocator allocator

    The type of memory to allocate.

    Returns
    Type Description
    NativeArray<T>

    An array containing the specified component for all the entities selected by the EntityQuery.

    Type Parameters
    Name Description
    T

    The component type.

    Remarks

    This version of the function blocks on all registered jobs that access any of the query components.

    Exceptions
    Type Condition
    InvalidOperationException

    Thrown if T is not part of the query.

    ToComponentDataArray<T>(NativeArray<Entity>, Allocator)

    Creates a NativeArray containing the components of type T for the selected entities, given an input entity list to limit the search.

    Declaration
    [BurstCompatible(GenericTypeArguments = new Type[]{typeof(BurstCompatibleComponentData)})]
    public NativeArray<T> ToComponentDataArray<T>(NativeArray<Entity> entityArray, Allocator allocator)
        where T : struct, IComponentData
    Parameters
    Type Name Description
    NativeArray<Entity> entityArray

    The list of entities to be considered. Only entities in this list will be considered as output.

    Allocator allocator

    The type of memory to allocate.

    Returns
    Type Description
    NativeArray<T>

    An array containing all the entities selected by the EntityQuery.

    Type Parameters
    Name Description
    T

    The component type.

    Remarks

    This version of the function blocks on all registered jobs that access any of the query components.

    ToComponentDataArray<T>()

    Declaration
    [NotBurstCompatible]
    public T[] ToComponentDataArray<T>()
        where T : class, IComponentData
    Returns
    Type Description
    T[]
    Type Parameters
    Name Description
    T
    In This Article
    • ToComponentDataArray<T>(Allocator)
    • ToComponentDataArray<T>(NativeArray<Entity>, Allocator)
    • ToComponentDataArray<T>()
    Back to top
    Terms of use
    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