docs.unity.cn
    Show / Hide Table of Contents

    Method CreateEntity

    CreateEntity(Int32, EntityArchetype)

    Records a command to create an entity with specified archetype.

    Declaration
    public Entity CreateEntity(int sortKey, EntityArchetype archetype)
    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).

    EntityArchetype archetype

    The archetype of the new entity.

    Returns
    Type Description
    Entity

    An entity that is deferred and will be fully realized when this EntityCommandBuffer is played back.

    Exceptions
    Type Condition
    ArgumentException

    Throws if the archetype is null.

    NullReferenceException

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

    CreateEntity(Int32)

    Records a command to create an entity with no components.

    Declaration
    public Entity CreateEntity(int sortKey)
    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).

    Returns
    Type Description
    Entity

    An entity that is deferred and will be fully realized when this EntityCommandBuffer is played back.

    Exceptions
    Type Condition
    NullReferenceException

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

    Back to top Copyright © 2022 Unity Technologies
    Generated by DocFX
    on Wednesday, July 6, 2022
    Terms of use