Gameframe.Async 👋

![GitHub release (latest by date including pre-releases)](https://camo.githubusercontent.com/4bc0ebb55329c64f4dd935f7ac3067d1077dc554704d16d4c4f1d049b5e97ac6/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f762f72656c656173652f636f72796c656163682f556e6974794173796e633f696e636c7564655f70726572656c6561736573) [![openupm](https://img.shields.io/npm/v/com.gameframe.async?label=openupm&registry_uri=https://package.openupm.com)](https://openupm.com/packages/com.gameframe.async/) [![license](https://camo.githubusercontent.com/e8427d5f3bc2f5099ebe0022334685447969f3e8e09693a2c15ff72136f6427f/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6c6963656e73652f636f72796c656163682f556e6974794173796e63)](https://github.com/coryleach/UnityAsync/raw/master/LICENSE) > Async task utility package for Unity > Helper methods for starting tasks on the Unity thread. > Start and await coroutines from any thread. ## Quick Package Install #### Using UnityPackageManager (for Unity 2019.3 or later) Open the package manager window (menu: Window > Package Manager)
Select "Add package from git URL...", fill in the pop-up with the following link:
https://github.com/coryleach/UnityAsync.git#1.0.7
#### Using UnityPackageManager (for Unity 2019.1 or later) Find the manifest.json file in the Packages folder of your project and edit it to look like this: ```js { "dependencies": { "com.gameframe.async": "https://github.com/coryleach/UnityAsync.git#1.0.7", ... }, } ``` ### Using OpenUPM The package is available on the [openupm registry](https://openupm.com). It's recommended to install it via [openupm-cli](https://github.com/openupm/openupm-cli). ```console openupm add com.gameframe.async ``` ## Quick Start ### Start and Await a coroutine from anywhere ```c# //Start a coroutine from anywhere without a monobehaviour //Your coroutine will run on the main thread var task = CoroutineRunner.RunAsync(MyCoroutine()); //You can await the returned task which will complete when the coroutine is done await task; ``` ### Start a Task on the main unity thread from anywhere ```c# //This will execute MyMethod on the main Unity thread var task = UnityTaskUtil.RunOnUnityThreadAsync(MyMethod); //A task is returned that you can await await task; ``` ### Switch between Main thread and Background thread in any task ```c# // Currently on main thread await Awaiters.BackgroundThread; //You should now be on a background thread //Await one frame await Awaiters.NextFrame; //Currently on a background thread await Awaiters.MainUnityThread; //Task is now running on the Unity main thread ``` ## Author 👤 **Cory Leach** * Twitter: [@coryleach](https://twitter.com/coryleach) * Github: [@coryleach](https://github.com/coryleach) ## Show your support Give a ⭐️ if this project helped you! *** _This README was generated with ❤️ by [Gameframe.Packages](https://github.com/coryleach/unitypackages)_