docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Method Has

    Has<T>(ref ComponentTypeHandle<T>)

    Reports whether this chunk contains the specified component type.

    Declaration
    public readonly bool Has<T>(ref ComponentTypeHandle<T> typeHandle) where T : IComponentData, new()
    Parameters
    Type Name Description
    ComponentTypeHandle<T> typeHandle

    An object containing type and job safety information. To create this object, call GetComponentTypeHandle<T>(bool). Pass the object to a job using a public field you define as part of the job struct.

    Returns
    Type Description
    bool

    True, if this chunk contains an array of the specified component type.

    Type Parameters
    Name Description
    T

    The data type of the component.

    Remarks

    When an EntityQuery includes optional components (using WithAny<T1>()), some chunks returned by the query may contain such components and some may not. Use this function to determine whether or not the current chunk contains one of these optional component types.

    Has<T>(ComponentTypeHandle<T>)

    Obsolete. Use Has<T>(ref ComponentTypeHandle<T>) instead.

    Declaration
    [Obsolete("The typeHandle argument should now be passed by ref. (RemovedAfter Entities 1.0)", false)]
    public readonly bool Has<T>(ComponentTypeHandle<T> typeHandle) where T : IComponentData, new()
    Parameters
    Type Name Description
    ComponentTypeHandle<T> typeHandle

    An object containing type and job safety information. To create this object, call GetComponentTypeHandle<T>(bool). Pass the object to a job using a public field you define as part of the job struct.

    Returns
    Type Description
    bool

    True, if this chunk contains an array of the specified component type.

    Type Parameters
    Name Description
    T

    The data type of the component.

    Has<T>()

    Reports whether this chunk contains the specified component type.

    Declaration
    public readonly bool Has<T>()
    Returns
    Type Description
    bool

    True, if this chunk contains an array of the specified component type.

    Type Parameters
    Name Description
    T

    The data type of the component.

    Remarks

    When an EntityQuery includes optional components (using WithAny<T1>()), some chunks returned by the query may contain such components and some may not. Use this function to determine whether or not the current chunk contains one of these optional component types.

    Has(ref DynamicComponentTypeHandle)

    Reports whether this chunk contains the specified component type.

    Declaration
    public readonly bool Has(ref DynamicComponentTypeHandle typeHandle)
    Parameters
    Type Name Description
    DynamicComponentTypeHandle typeHandle

    Type handle for the component type to query.

    Returns
    Type Description
    bool

    True, if this chunk contains an array of the specified component type.

    Has(DynamicComponentTypeHandle)

    Obsolete. Use Has(ref DynamicComponentTypeHandle) instead.

    Declaration
    [Obsolete("The typeHandle argument should now be passed by ref. (RemovedAfter Entities 1.0)", false)]
    public readonly bool Has(DynamicComponentTypeHandle typeHandle)
    Parameters
    Type Name Description
    DynamicComponentTypeHandle typeHandle

    Type handle for the component type to query.

    Returns
    Type Description
    bool

    True, if this chunk contains an array of the specified component type.

    Has<T>(SharedComponentTypeHandle<T>)

    Reports whether this chunk contains a shared component of the specified component type.

    Declaration
    public readonly bool Has<T>(SharedComponentTypeHandle<T> typeHandle) where T : struct, ISharedComponentData
    Parameters
    Type Name Description
    SharedComponentTypeHandle<T> typeHandle

    An object containing type and job safety information. To create this object, call GetSharedComponentTypeHandle<T>(). Pass the object to a job using a public field you define as part of the job struct.

    Returns
    Type Description
    bool

    True, if this chunk contains a shared component of the specified type.

    Type Parameters
    Name Description
    T

    The data type of the shared component.

    Remarks

    When an EntityQuery includes optional components used as shared components (with WithAny<T1>()), some chunks returned by the query may have these shared components and some may not. Use this function to determine whether or not the current chunk contains one of these optional component types as a shared component.

    Has(ref DynamicSharedComponentTypeHandle)

    Reports whether this chunk contains a shared component of the specified component type.

    Declaration
    public readonly bool Has(ref DynamicSharedComponentTypeHandle typeHandle)
    Parameters
    Type Name Description
    DynamicSharedComponentTypeHandle typeHandle

    An object containing type and job safety information. To create this object, call GetDynamicSharedComponentTypeHandle(ComponentType).

    Returns
    Type Description
    bool

    True, if this chunk contains a shared component of the specified type.

    Remarks

    When an EntityQuery includes optional components used as shared components (with WithAny<T1>()), some chunks returned by the query may have these shared components and some may not. Use this function to determine whether or not the current chunk contains one of these optional component types as a shared component.

    Has(DynamicSharedComponentTypeHandle)

    Obsolete. Use Has(ref DynamicSharedComponentTypeHandle) instead.

    Declaration
    [Obsolete("The typeHandle argument should now be passed by ref. (RemovedAfter Entities 1.0)", false)]
    public readonly bool Has(DynamicSharedComponentTypeHandle typeHandle)
    Parameters
    Type Name Description
    DynamicSharedComponentTypeHandle typeHandle

    An object containing type and job safety information. To create this object, call GetDynamicSharedComponentTypeHandle(ComponentType).

    Returns
    Type Description
    bool

    True, if this chunk contains a shared component of the specified type.

    Remarks

    When an EntityQuery includes optional components used as shared components (with WithAny<T1>()), some chunks returned by the query may have these shared components and some may not. Use this function to determine whether or not the current chunk contains one of these optional component types as a shared component.

    Has<T>(ref BufferTypeHandle<T>)

    Reports whether this chunk contains a dynamic buffer containing the specified component type.

    Declaration
    public readonly bool Has<T>(ref BufferTypeHandle<T> bufferTypeHandle) where T : unmanaged, IBufferElementData
    Parameters
    Type Name Description
    BufferTypeHandle<T> bufferTypeHandle

    An object containing type and job safety information. To create this object, call GetBufferTypeHandle<T>(bool). Pass the object to a job using a public field you define as part of the job struct.

    Returns
    Type Description
    bool

    True, if this chunk contains an array of the dynamic buffers containing the specified component type.

    Type Parameters
    Name Description
    T

    The data type of the component stored in the dynamic buffer.

    Remarks

    When an EntityQuery includes optional dynamic buffer types (with WithAny<T1>()), some chunks returned by the query may have these dynamic buffers components and some may not. Use this function to determine whether or not the current chunk contains one of these optional dynamic buffers.

    Has<T>(BufferTypeHandle<T>)

    Obsolete. Use Has<T>(ref BufferTypeHandle<T>) instead.

    Declaration
    [Obsolete("The bufferTypeHandle argument should now be passed by ref. (RemovedAfter Entities 1.0)", false)]
    public readonly bool Has<T>(BufferTypeHandle<T> bufferTypeHandle) where T : unmanaged, IBufferElementData
    Parameters
    Type Name Description
    BufferTypeHandle<T> bufferTypeHandle

    An object containing type and job safety information. To create this object, call GetBufferTypeHandle<T>(bool). Pass the object to a job using a public field you define as part of the job struct.

    Returns
    Type Description
    bool

    True, if this chunk contains an array of the dynamic buffers containing the specified component type.

    Type Parameters
    Name Description
    T

    The data type of the component stored in the dynamic buffer.

    In This Article
    Back to top
    Copyright © 2024 Unity Technologies — Trademarks and terms of use
    • Legal
    • Privacy Policy
    • Cookie Policy
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)