Struct EntityChangeSet
An atomic package of changes to entity and component data.
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
Fields
AddComponents
A set of all component additions in this change-set.
Declaration
public readonly NativeArray<PackedComponent> AddComponents
Field Value
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
EntityPatches
A packed set of all entity references to patch.
Declaration
public readonly NativeArray<EntityReferenceChange> EntityPatches
Field Value
LinkedEntityGroupAdditions
A set of all linked entity group additions.
Declaration
public readonly NativeArray<LinkedEntityGroupChange> LinkedEntityGroupAdditions
Field Value
LinkedEntityGroupRemovals
A set of all linked entity group removals.
Declaration
public readonly NativeArray<LinkedEntityGroupChange> LinkedEntityGroupRemovals
Field Value
Names
Names for each entity in this change-set.
Declaration
public readonly NativeArray<NativeString64> Names
Field Value
Payload
Data payload for all component changes specified in SetComponents
Declaration
public readonly NativeArray<byte> Payload
Field Value
| Type |
Description |
| NativeArray<System.Byte> |
|
RemoveComponents
A set of all component removals in this change-set.
Declaration
public readonly NativeArray<PackedComponent> RemoveComponents
Field Value
SetComponents
A set of all component data modifications in this change-set.
Declaration
public readonly NativeArray<PackedComponentDataChange> SetComponents
Field Value
SetSharedComponents
A set of all shared component data changes.
Declaration
public readonly PackedSharedComponentDataChange[] SetSharedComponents
Field Value
TypeHashes
A packed array of all types in this change-set.
Declaration
public readonly NativeArray<ComponentTypeHash> TypeHashes
Field Value
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
Dispose()
Declaration
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.