Documentation

Unity Engine


Unity Engine


Schedule

Adds an IJobEntity instance to the job scheduler queue for sequential (non-parallel) execution.
Read time 2 minutesLast updated 17 hours ago

Definition

  • Type: Method
  • Namespace: Unity.Entities
  • Assembly: UnityEngine.EntitiesModule

Schedule<T>(T, JobHandle)

Adds an IJobEntity instance to the job scheduler queue for sequential (non-parallel) execution.
public static JobHandle Schedule<T>(this T jobData, JobHandle dependsOn) where T : unmanaged, IJobEntity

Parameters

jobData

T
An IJobEntity instance.

dependsOn

The handle identifying already scheduled jobs that could constrain this job. A job that writes to a component cannot run in parallel with other jobs that read or write that component. Jobs that only read the same components can run in parallel.

Returns

Type

Description

JobHandleA handle that combines the current Job with previous dependencies identified by the
dependsOn
parameter.

Schedule<T>(T, EntityQuery, JobHandle)

Adds an IJobEntity instance to the job scheduler queue for sequential (non-parallel) execution.
public static JobHandle Schedule<T>(this T jobData, EntityQuery query, JobHandle dependsOn) where T : unmanaged, IJobEntity

Parameters

jobData

T
An IJobEntity instance.

The query selecting chunks with the necessary components.

dependsOn

The handle identifying already scheduled jobs that could constrain this job. A job that writes to a component cannot run in parallel with other jobs that read or write that component. Jobs that only read the same components can run in parallel.

Returns

Type

Description

JobHandleA handle that combines the current Job with previous dependencies identified by the
dependsOn
parameter.

Schedule<T>(T)

Adds an IJobEntity instance to the job scheduler queue for sequential (non-parallel) execution.
public static void Schedule<T>(this T jobData) where T : unmanaged, IJobEntity

Parameters

jobData

T
An IJobEntity instance.

Remarks

This job automatically uses the system's Dependency property as the input and output dependency.

Schedule<T>(T, EntityQuery)

Adds an IJobEntity instance to the job scheduler queue for sequential (non-parallel) execution.
public static void Schedule<T>(this T jobData, EntityQuery query) where T : unmanaged, IJobEntity

Parameters

jobData

T
An IJobEntity instance.

The query selecting chunks with the necessary components.

Remarks

This job automatically uses the system's Dependency property as the input and output dependency.