docs.unity3d.com
    Show / Hide Table of Contents

    Method DestroyEntity

    DestroyEntity(Int32, Entity)

    Records a command to destroy an entity.

    Declaration
    public void DestroyEntity(int sortKey, Entity e)
    Parameters
    Type Name Description
    Int32 sortKey

    A unique index for each set of commands added to this EntityCommandBuffer across all parallel jobs writing commands to this buffer. The entityInQueryIndex argument provided by Entities is an appropriate value to use for this parameter. In an IJobEntityBatch pass the 'batchIndex' value from Execute(ArchetypeChunk, Int32).

    Entity e

    The entity to destroy.

    Remarks

    Behavior at Playback: This command will throw an error if any of the entities are still deferred or were destroyed between recording and playback.

    Exceptions
    Type Condition
    NullReferenceException

    Throws if an Allocator was not passed in when the EntityCommandBuffer was created.

    DestroyEntity(Int32, NativeArray<Entity>)

    Records a command to destroy a NativeArray of entities.

    Declaration
    public void DestroyEntity(int sortKey, NativeArray<Entity> entities)
    Parameters
    Type Name Description
    Int32 sortKey

    A unique index for each set of commands added to this EntityCommandBuffer across all parallel jobs writing commands to this buffer. The entityInQueryIndex argument provided by Entities is an appropriate value to use for this parameter. In an IJobEntityBatch pass the 'batchIndex' value from Execute(ArchetypeChunk, Int32).

    NativeArray<Entity> entities

    The NativeArray of entities to destroy.

    Remarks

    Behavior at Playback: This command will do nothing if entities has a count of 0. This command will throw an error if any of the entities are still deferred or were destroyed between recording and playback.

    Exceptions
    Type Condition
    NullReferenceException

    Throws if an Allocator was not passed in when the EntityCommandBuffer was created.

    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