Method Instantiate
Instantiate(Entity)
Records a command to create an entity with specified entity prefab.
Declaration
public Entity Instantiate(Entity e)Parameters
| Type | Name | Description |
|---|---|---|
| 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 has the same components and component values as the prefab entity, minus the Prefab tag component. If the source entity was destroyed before playback, this command throws an error.
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. |
| InvalidOperationException | Throws if this EntityCommandBuffer has already been played back. |
Instantiate(Entity, NativeArray<Entity>)
Records a command to create a NativeArray of entities with specified entity prefab.
Declaration
public void Instantiate(Entity e, NativeArray<Entity> entities)Parameters
| Type | Name | Description |
|---|---|---|
| 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 has the same components and component values as the prefab entity, minus the Prefab tag component. If the source entity was destroyed before playback, this command throws an error.
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. |
| InvalidOperationException | Throws if this EntityCommandBuffer has already been played back. |