Instantiate
Records a command to create an entity with specified entity prefab.
Read time 2 minutesLast updated a day ago
Definition
- Type: Method
- Namespace: Unity.Entities
- Assembly: UnityEngine.EntitiesModule
Instantiate(int, Entity)
Records a command to create an entity with specified entity prefab.
public Entity Instantiate(int sortKey, Entity e)
Parameters
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 IJobChunk.Execute.
The entity prefab.
Returns
Type | Description |
|---|---|
| Entity | An entity that will be assigned a chunk 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.
Instantiate(int, Entity, NativeArray<Entity>)
Records a command to create a NativeArray of entities with specified entity prefab.
public void Instantiate(int sortKey, Entity e, NativeArray<Entity> entities)
Parameters
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 IJobChunk.Execute.
The entity prefab.
The NativeArray of entities that will be assigned chunks 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.