v1.1.0
Latest
2021.3+
Class TaskScheduler
Provides the means to schedule tasks on a background thread or the main thread. Also allows for creation of co-routines from classes that do not inherit from MonoBehaviour.
This is thread safe, through it must be constructed on the main thread.
Inherited Members
UnityEngine.Component.GetComponentInParent<T>(System.Boolean)
UnityEngine.Object.FindObjectsByType<T>(UnityEngine.FindObjectsSortMode)
UnityEngine.Object.FindObjectsOfType<T>(System.Boolean)
UnityEngine.Object.FindObjectsByType<T>(UnityEngine.FindObjectsInactive, UnityEngine.FindObjectsSortMode)
UnityEngine.Object.FindObjectOfType<T>(System.Boolean)
UnityEngine.Object.FindFirstObjectByType<T>()
UnityEngine.Object.FindAnyObjectByType<T>()
UnityEngine.Object.FindFirstObjectByType<T>(UnityEngine.FindObjectsInactive)
UnityEngine.Object.FindAnyObjectByType<T>(UnityEngine.FindObjectsInactive)
Namespace: Unity.Services.Relay.Scheduler
Syntax
public abstract class TaskScheduler : MonoBehaviourMethods
IsMainThread()
Determines whether the current thread is the main thread.
Declaration
public abstract bool IsMainThread()Returns
| Type | Description |
|---|---|
| Boolean | Whether or not this thread is the main thread. |
ScheduleBackgroundTask(Action)
Schedules a new task on a background thread.
Declaration
public abstract void ScheduleBackgroundTask(Action task)Parameters
| Type | Name | Description |
|---|---|---|
| Action | task | The task that should be executed on a background thread. |
ScheduleMainThreadTask(Action)
Schedules a new task on the main thread. The task will be executed during the next update.
Declaration
public abstract void ScheduleMainThreadTask(Action task)Parameters
| Type | Name | Description |
|---|---|---|
| Action | task | The task that should be executed on the main thread. |
ScheduleOrExecuteOnMain(Action)
Executes immediately if on main thread else queue on main thread for next update.
Declaration
public void ScheduleOrExecuteOnMain(Action action)Parameters
| Type | Name | Description |
|---|---|---|
| Action | action | The task that should be executed on the main thread. |