docs.unity3d.com
    Show / Hide Table of Contents

    Struct EntityQueryMask

    Provides an efficient test of whether a specific entity would be selected by an EntityQuery.

    Namespace: Unity.Entities
    Syntax
    public struct EntityQueryMask
    Remarks

    Use a mask to quickly identify whether an entity would be selected by an EntityQuery.

           var mask = EntityManager.GetEntityQueryMask(query);
           bool doesMatch = mask.Matches(entity);

    You can create up to 1024 unique EntityQueryMasks in an application. Note that EntityQueryMask only filters by Archetype, it doesn't support EntityQuery shared component or change filtering.

    Methods

    Name Description
    Matches(Entity)

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

    See Also

    GetEntityQueryMask(EntityQuery)
    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