About RMC & Unity3D

Rivello Multimedia Consulting (RMC) provides consulting services for applications and games. RMC specializes in Unity3D development (see our work here). Please contact us today with any questions, comments, and project quotes.

uEventDispatcher

Problem

Unity3D is a great gaming IDE and runtime. Like any tool I use regularly, I have many constructive criticisms as well. For example, there is no adequate one-to-many messaging system. The UnityEngine includes BroadcastMessage & SendMessage but it is not adequate and has many public, deserved criticisms.

Solution

Streamline messaging between classes using uEventDispatcher.

Benefits include;

1. Easily add/remove and dispatch custom communication
2. Strongly-typed data payload
3. Compiler properly warns you about major misuse cases (mistyping, etc…)
4. Works within any class type and requires no special ‘Interface’ or ‘Inheritance’
5. Does not rely on reflection (slow performance) like BroadcastMessage/SendMessage

Usage

Here is an example that shows the COMPLETE API of uEventDispatcher.

//--------------------------------------
//  Imports
//--------------------------------------
using UnityEngine;
using System.Collections;
using com.rmc.events;

//--------------------------------------
//  Class
//--------------------------------------
public class TestEventDispatcher : MonoBehaviour
{

	//--------------------------------------
	//  Properties
	//--------------------------------------
	// PRIVATE
	private EventDispatcher eventDispatcher;

	//--------------------------------------
	//  Methods
	//--------------------------------------

	// PUBLIC
	/// <summary>
	/// Start this instance.
	/// </summary>
	void Start ()
	{

		//CREATE
		eventDispatcher = new EventDispatcher (this);

		//ADD 0, 1, 2, OR MORE LISTENERS...
		eventDispatcher.addEventListener 			(TestEvent.TEST_EVENT_NAME, _onCustomEvent1); //default is EventDispatcherAddMode.DEFAULT
		eventDispatcher.addEventListener 			(TestEvent.TEST_EVENT_NAME, _onCustomEvent2, EventDispatcherAddMode.SINGLE_SHOT);

		//TEST REMOVE
		//eventDispatcher.removeAllEventListeners();
		//eventDispatcher.removeEventListener (TestEvent.TEST_EVENT_NAME, _onCustomEvent1);

		//TEST HAS
		//Debug.Log ("	hasEventListener(): " + 	eventDispatcher.hasEventListener 	(TestEvent.TEST_EVENT_NAME, _onCustomEvent1));

		//TEST EVENT SETUP FROM 3 DIFFERENT SCOPES
		eventDispatcher.dispatchEvent (new TestEvent (TestEvent.TEST_EVENT_NAME));

	}

	//--------------------------------------
	//  Events
	//--------------------------------------
	public void _onCustomEvent1 (IEvent iEvent)
	{
		Debug.Log ("	1. _onCustomEvent1(): " + iEvent);
	}

	public void _onCustomEvent2 (IEvent iEvent)
	{
		Debug.Log ("	2. _onCustomEvent2(): " + iEvent);
	}

}

Status

The project is now complete and live on the AssetStore. It is free. Check it out today!