Method AddSharedComponentManaged
AddSharedComponentManaged<T>(int, Entity, T)
Records a command to add a shared component value on an entity.
Declaration
public void AddSharedComponentManaged<T>(int sortKey, Entity e, T sharedComponent) where T : struct, ISharedComponentData
Parameters
Type | Name | Description |
---|---|---|
int | sortKey | A unique index for each set of commands added to this EntityCommandBuffer across all parallel jobs writing commands to this buffer. The ChunkIndexInQuery provided by IJobEntity is an appropriate value to use for this parameter. In an IJobChunk pass the 'unfilteredChunkIndex' value from Execute(in ArchetypeChunk, int, bool, in v128). |
Entity | e | The entity to add the shared component value to. |
T | sharedComponent | The shared component value to add. |
Type Parameters
Name | Description |
---|---|
T | The type of shared component to add. |
Remarks
At playback, this command throws an error if this entity is destroyed before playback, if this entity is still deferred, if adding this shared component exceeds the maximum number of shared components, or adding a component type makes the archetype too large.
Exceptions
Type | Condition |
---|---|
NullReferenceException | Throws if an Allocator was not passed in when the EntityCommandBuffer was created. |
AddSharedComponentManaged<T>(int, NativeArray<Entity>, T)
Records a command to add a possibly-managed shared component value on a NativeArray of entities.
Declaration
public void AddSharedComponentManaged<T>(int sortKey, NativeArray<Entity> entities, T sharedComponent) where T : struct, ISharedComponentData
Parameters
Type | Name | Description |
---|---|---|
int | sortKey | A unique index for each set of commands added to this EntityCommandBuffer across all parallel jobs writing commands to this buffer. The ChunkIndexInQuery provided by IJobEntity is an appropriate value to use for this parameter. In an IJobChunk pass the 'unfilteredChunkIndex' value from Execute(in ArchetypeChunk, int, bool, in v128). |
NativeArray<Entity> | entities | The NativeArray of entities to add the shared component value to. |
T | sharedComponent | The shared component value to add. |
Type Parameters
Name | Description |
---|---|
T | The type of shared component to add. |
Remarks
At playback, this command throws an error if any entity is destroyed before playback, if any entity is still deferred, if adding this shared component exceeds the maximum number of shared components, or adding a component type makes the archetype too large.
Exceptions
Type | Condition |
---|---|
NullReferenceException | Throws if an Allocator was not passed in when the EntityCommandBuffer was created. |