Version: Unity 7.0 Alpha (7000.0)
LanguageEnglish
  • C#

EntityCommandBuffer.ParallelWriter.Instantiate

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Declaration

public Entity Instantiate(int sortKey, Entity e);

Parameters

Parameter Description
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 IJobChunk.Execute.
e The entity prefab.

Returns

Entity An entity that will be assigned a chunk when this EntityCommandBuffer is played back.

Description

Records a command to create an entity with specified entity prefab.

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.


Declaration

public void Instantiate(int sortKey, Entity e, NativeArray<Entity> entities);

Parameters

Parameter Description
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 IJobChunk.Execute.
e The entity prefab.
entities The NativeArray of entities that will be assigned chunks when this EntityCommandBuffer is played back.

Description

Records a command to create a NativeArray of entities with specified entity prefab.

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.