Method Instantiate
Instantiate(int, Entity)
Records a command to create an entity with specified entity prefab.
Declaration
public Entity Instantiate(int sortKey, Entity e)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 prefab. |
Returns
| Type | Description |
|---|---|
| Entity | An entity that is deferred and will be fully realized when this EntityCommandBuffer is played back. |
Remarks
An instantiated entity will have the same components and component values as the prefab entity, minus the Prefab tag component. At playback, this command will throw an error if the source entity was destroyed before playback.
Exceptions
| Type | Condition |
|---|---|
| ArgumentNullException | Thrown if Entity e is null and if safety checks are enabled. |
| NullReferenceException | Throws if an Allocator was not passed in when the EntityCommandBuffer was created. |
Instantiate(int, Entity, NativeArray<Entity>)
Records a command to create a NativeArray of entities with specified entity prefab.
Declaration
public void Instantiate(int sortKey, Entity e, NativeArray<Entity> entities)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 prefab. |
| NativeArray<Entity> | entities | The NativeArray of entities that will be populated with realized entities when this EntityCommandBuffer is played back. |
Remarks
An instantiated entity will have the same components and component values as the prefab entity, minus the Prefab tag component. At playback, this command will throw an error if the source entity was destroyed before playback.
Exceptions
| Type | Condition |
|---|---|
| ArgumentNullException | Thrown if Entity e is null and if safety checks are enabled. |
| NullReferenceException | Throws if an Allocator was not passed in when the EntityCommandBuffer was created. |