Struct EntityChangeSet | Package Manager UI website
docs.unity3d.com
    Show / Hide Table of Contents

    Struct EntityChangeSet

    An atomic package of changes to entity and component data.

    Namespace: Unity.Entities
    Syntax
    public struct EntityChangeSet : IDisposable

    Constructors

    EntityChangeSet(Int32, Int32, NativeArray<EntityGuid>, NativeArray<ComponentTypeHash>, NativeArray<NativeString64>, NativeArray<PackedComponent>, NativeArray<PackedComponent>, NativeArray<PackedComponentDataChange>, NativeArray<Byte>, NativeArray<EntityReferenceChange>, PackedSharedComponentDataChange[], NativeArray<LinkedEntityGroupChange>, NativeArray<LinkedEntityGroupChange>)

    Declaration
    public EntityChangeSet(int createdEntityCount, int destroyedEntityCount, NativeArray<EntityGuid> entities, NativeArray<ComponentTypeHash> typeHashes, NativeArray<NativeString64> names, NativeArray<PackedComponent> addComponents, NativeArray<PackedComponent> removeComponents, NativeArray<PackedComponentDataChange> setComponents, NativeArray<byte> payload, NativeArray<EntityReferenceChange> entityPatches, PackedSharedComponentDataChange[] setSharedComponents, NativeArray<LinkedEntityGroupChange> linkedEntityGroupAdditions, NativeArray<LinkedEntityGroupChange> linkedEntityGroupRemovals)
    Parameters
    Type Name Description
    System.Int32 createdEntityCount
    System.Int32 destroyedEntityCount
    NativeArray<EntityGuid> entities
    NativeArray<ComponentTypeHash> typeHashes
    NativeArray<NativeString64> names
    NativeArray<PackedComponent> addComponents
    NativeArray<PackedComponent> removeComponents
    NativeArray<PackedComponentDataChange> setComponents
    NativeArray<System.Byte> payload
    NativeArray<EntityReferenceChange> entityPatches
    PackedSharedComponentDataChange[] setSharedComponents
    NativeArray<LinkedEntityGroupChange> linkedEntityGroupAdditions
    NativeArray<LinkedEntityGroupChange> linkedEntityGroupRemovals

    Fields

    AddComponents

    A set of all component additions in this change-set.

    Declaration
    public readonly NativeArray<PackedComponent> AddComponents
    Field Value
    Type Description
    NativeArray<PackedComponent>

    CreatedEntityCount

    Number of entities from the start of Entities that should be considered as created.

    Declaration
    public readonly int CreatedEntityCount
    Field Value
    Type Description
    System.Int32

    DestroyedEntityCount

    Number of entities from the end of Entities that should be considered as destroyed.

    Declaration
    public readonly int DestroyedEntityCount
    Field Value
    Type Description
    System.Int32

    Entities

    A packed array of all entities in this change-set.

    Declaration
    public readonly NativeArray<EntityGuid> Entities
    Field Value
    Type Description
    NativeArray<EntityGuid>

    EntityPatches

    A packed set of all entity references to patch.

    Declaration
    public readonly NativeArray<EntityReferenceChange> EntityPatches
    Field Value
    Type Description
    NativeArray<EntityReferenceChange>

    LinkedEntityGroupAdditions

    A set of all linked entity group additions.

    Declaration
    public readonly NativeArray<LinkedEntityGroupChange> LinkedEntityGroupAdditions
    Field Value
    Type Description
    NativeArray<LinkedEntityGroupChange>

    LinkedEntityGroupRemovals

    A set of all linked entity group removals.

    Declaration
    public readonly NativeArray<LinkedEntityGroupChange> LinkedEntityGroupRemovals
    Field Value
    Type Description
    NativeArray<LinkedEntityGroupChange>

    Names

    Names for each entity in this change-set.

    Declaration
    public readonly NativeArray<NativeString64> Names
    Field Value
    Type Description
    NativeArray<NativeString64>

    Payload

    Data payload for all component changes specified in SetComponents

    Declaration
    public readonly NativeArray<byte> Payload
    Field Value
    Type Description
    NativeArray<System.Byte>
    Remarks

    Data changes are tightly packed. Use the Size to read back.

    RemoveComponents

    A set of all component removals in this change-set.

    Declaration
    public readonly NativeArray<PackedComponent> RemoveComponents
    Field Value
    Type Description
    NativeArray<PackedComponent>

    SetComponents

    A set of all component data modifications in this change-set.

    Declaration
    public readonly NativeArray<PackedComponentDataChange> SetComponents
    Field Value
    Type Description
    NativeArray<PackedComponentDataChange>

    SetSharedComponents

    A set of all shared component data changes.

    Declaration
    public readonly PackedSharedComponentDataChange[] SetSharedComponents
    Field Value
    Type Description
    PackedSharedComponentDataChange[]

    TypeHashes

    A packed array of all types in this change-set.

    Declaration
    public readonly NativeArray<ComponentTypeHash> TypeHashes
    Field Value
    Type Description
    NativeArray<ComponentTypeHash>

    Properties

    HasChanges

    Declaration
    public bool HasChanges { get; }
    Property Value
    Type Description
    System.Boolean

    IsCreated

    Returns true if this object is allocated.

    Declaration
    public bool IsCreated { get; }
    Property Value
    Type Description
    System.Boolean

    Methods

    Clone(Allocator)

    Declaration
    public EntityChangeSet Clone(Allocator allocator)
    Parameters
    Type Name Description
    Allocator allocator
    Returns
    Type Description
    EntityChangeSet

    Dispose()

    Declaration
    public void Dispose()
    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