Skip to content

Latest commit

 

History

History
63 lines (44 loc) · 2.43 KB

README.md

File metadata and controls

63 lines (44 loc) · 2.43 KB
Raw

UnityMainThreadDispatcher

A thread-safe way of dispatching IEnumerator functions to the main thread in unity. Useful for calling UI functions and other actions that Unity limits to the main thread from different threads. Initially written for Firebase Unity but now used across the board!

Version

1.0 - Tested and functional in one or more production applications, including those from major companies.

Installation

No dependencies needed other than Unity. This script was created in Unity 5.3, and has been tested in 5.3, 5.4, and 5.5 by the creators, but is being used across many more versions. If something breaks, let us know!

  1. Download the UnityMainThreadDispatcher prefab and add it to your scene, or simple create an empty GameObject, call it UnityMainThreadDispatcher.
  2. Download the UnityMainThreadDispatcher.cs script and add it to your prefab
  3. You can now dispatch objects to the main thread in Unity.

Add in manifest.json

   com.pimdewitte.unitymainthreaddispatcher": "https://github.com/RimuruDev/UnityMainThreadDispatcher.git"

Usage

	public IEnumerator ThisWillBeExecutedOnTheMainThread() {
		Debug.Log ("This is executed from the main thread");
		yield return null;
	}
	public void ExampleMainThreadCall() {
		UnityMainThreadDispatcher.Instance().Enqueue(ThisWillBeExecutedOnTheMainThread()); 
	}

OR

	UnityMainThreadDispatcher.Instance().Enqueue(() => Debug.Log ("This is executed from the main thread"));

Development

Want to contribute? Great! If you find a bug or want to make improvements, simply fork the repo and make a pull request with your changes on your own fork.

Also - I'm looking for additional maintainers who are still actively using this in production as I now run a startup and am not actively working on Unity anymore

Nakama Server Usage Example

    private void OnNakamaServerConnect()
    {
	// Get MonoBehaviour Instance
        UnityMainThreadDispatcher mainThread = UnityMainThreadDispatcher.Instance();
        
        // Setup network event handlers.
        Connection.GetSocket.ReceivedMatchmakerMatched += m => mainThread.Enqueue(() => OnReceivedMatchmakerMatched(m));
        Connection.GetSocket.ReceivedMatchPresence += m => mainThread.Enqueue(() => OnReceivedMatchPresence(m));
        Connection.GetSocket.ReceivedMatchState += m => mainThread.Enqueue(async () => await OnReceivedMatchState(m));
    }

Author Original Realization

@PimDeWitte