Struct EntityQueryMask | Entities | 0.7.0-preview.19
docs.unity3d.com
    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 © 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