com.chartboost.unity.threading
v1.0.0
Published
Reusable Threading Utilities for Chartboost's Unity Projects
Downloads
1,399
Readme
Chartboost MainThreadDispatcher Plugin for Unity
A way of dispatching functions to the main thread in Unity projects. Useful for functions that Unity limits to the main thread from different threads.
Installation
This package is meant to be a dependency for other Chartboost Packages;however, if you wish to use it by itself, it can be installed through UPM & NuGet as follows:
"dependencies": {
"com.chartboost.unity.threading": "1.0.0",
...
},
"scopedRegistries": [
{
"name": "NpmJS",
"url": "https://registry.npmjs.org",
"scopes": [
"com.chartboost"
]
}
]
Usage
Simple Actions
Utilize the following methods to execute calls on the main thread:
void TestAction(object state){
//Execute logic on main thread
Debug.Log("This is called in the main thread")
}
// Synchronous; blocks until the callback completes
MainThreadDispatcher.Send(TestAction);
// Asynchronous; send and forget
MainThreadDispatcher.Post(TestAction)
Tasks
Taks can be utilized in Unity. However, if they contain code that must run on the Unity main thread, the Task too should also be run in the main thread. Use the following:
MainThreadDispatcher.MainThreadTask(async () =>{
// Mostly useful when calling task initially from outside of the Unity environment
await myTask();
});
Task Continuations
Task continuations are useful when trying to call asynchronous code from a synchronous environment. The following examples represent the same logic.
private void MySyncrhonousMethod(){
MyAsynchornousTask().ContinueWithOnMainThread(taskContinuationResultTask => {
// perform any continuation logic here.
Debug.Log("My task finished!")
});
}
private async void MyAsyncrhonousMethod(){
var taskResult = awat MyAsynchronousTask();
Debug.Log("My task finished!")
}