Struct EntityQueryMask | Entities | 0.8.0-preview.8
docs.unity.cn
    Show / Hide Table of Contents

    Struct EntityQueryMask

    A EntityQueryMask provides a fast check of whether an entity would be selected by an entity query.

    Namespace: Unity.Entities
    Syntax
    public struct EntityQueryMask
    Remarks

    Create an entity query mask using the GetEntityQueryMask(EntityQuery) function.

    You can create up to 1024 unique EntityQueryMasks instances in a given progrom. Entity query masks cannot be created from entity queries with filters.

    Methods

    Matches(Entity)

    Reports whether an entity would be selected by the EntityQuery instance used to create this entity query mask.

    Declaration
    public bool Matches(Entity entity)
    Parameters
    Type Name Description
    Entity entity

    The entity to check.

    Returns
    Type Description
    Boolean

    True if the entity would be returned by the EntityQuery, false if it would not.

    Remarks

    The check does not take the results of filters into account.

    See Also

    GetEntityQueryMask(EntityQuery)
    Back to top Copyright © 2020 Unity Technologies
    Generated by DocFX