Skip to content

Commit d998cb6

Browse files
committed
Update README.md
1 parent 88c5448 commit d998cb6

1 file changed

Lines changed: 12 additions & 2 deletions

File tree

README.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,14 @@
1-
Unity Event Aggregator
1+
Unity3D Event Aggregator
22
======================
33

4-
Event aggregation in Unity made easy! Decouple your GameObjects for simpler and cleaner code.
4+
Event aggregation in Unity3D made easy! Decouple your GameObjects for simpler and cleaner code.
5+
6+
#### Why Should I Care?
7+
[Look at how gross this is.](http://docs.unity3d.com/412/Documentation/ScriptReference/index.Accessing_Other_Game_Objects.html) Disgusting, huh? Now what if there was an easy way to send messages to other game objects in Unity3D without coupling everything to hell or using skittles magic?
8+
9+
#### That way is here.
10+
Just flop the .dll into your existing Unity3D project and get started. Messages must be a struct (because we're a green framework and want to create less garbage).
11+
12+
To start listening to events, your MonoBehaviour must also inherit from `IListener<(message)>`. This will create the handler for the message.
13+
14+
Make sure you register and unregister with the `EventAggregator` in your MonoBehaviour's `Start` and `OnDestroy` methods. I'll probably create a base class to inherit from that will do this automatically for you...when I'm feeling less lazy.

0 commit comments

Comments
 (0)