https://github.com/mattak/Unibus

Unibus is event passing system for Unity3D. 🚀
https://github.com/mattak/Unibus

unity3d

Last synced: 3 months ago
JSON representation

Unibus is event passing system for Unity3D. 🚀

• Host: GitHub
• URL: https://github.com/mattak/Unibus
• Owner: mattak
• License: mit
• Created: 2016-06-13T15:37:22.000Z (over 8 years ago)
• Default Branch: main
• Last Pushed: 2024-01-03T13:16:27.000Z (10 months ago)
• Last Synced: 2024-07-14T04:37:49.151Z (4 months ago)
• Topics: unity3d
• Language: C#
• Homepage:
• Size: 564 KB
• Stars: 64
• Watchers: 5
• Forks: 10
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.md

Awesome Lists containing this project

• awesome-unity-open-source-on-github - Unibus - Unibus is event passing system (Message Bus)

README

        
# Unibus

![Unibus](./art/unibus.png)

Unibus is event passing system for Unity3D.

It is inspired by EventBus.

# Why Unibus?

Unity is great framework for creating game, but there is no standard event passing system.

For example in GameJam, there is no time to solve GameObject dependencies and create so many callback.

So I create instant event passing system.

It's easy to use, thin dependency, flexible to fit any type of message.

# Architecture

![Unibus](./art/unibus_message_passing.png)

Unibus is singleton GameObject.

It manages receivers and senders to handle message. 

The message is classified by tag and type.

For example, if you dispatch message with `HP` tag and `int` type, then receivers subscribing `HP` tag and `int` type can only receives the dispatched value.

# Install

Install from UPM

```

{

  "dependencies": {

    "me.mattak.unibus": "https://github.com/mattak/Unibus.git?path=Assets/Plugins/Unibus"

   }

}

```

# Usage

## 1. Place Unibus object

Place `Unibus` prefab object into your scene.

It will be singleton to handle event.

![Place Unibus prefab](./art/place_unibus_prefab.png)

Then it's ready to use.

## 2. Implement event sender

Send any event what you want.

```csharp

using UnibusEvent;

public class SampleEventSender : MonoBehaviour

{

    void OnClick()

    {

        // Send string message

        Unibus.Dispatch("message");

    }

}

```

## 3. Implement event receiver

Receive sent message.

```csharp

using UnibusEvent;

public class SampleEventReceiver : MonoBehavour

{

    void OnEnable()

    {

        Unibus.Subscribe(OnEvent);

    }

    void OnDisable()

    {

        Unibus.Unsubscribe(OnEvent);

    }

    // This is receiver

    void OnEvent(string message)

    {

        var text = this.GetComponent();

        text.text = message;

    }

}

```

Or you can use simple style subscriber.

`BindUntilDisable()` is shortcut to unsubscribe automatically when gameobject reach `onDisable()`.

```csharp

using UnibusEvent;

public class SampleEventReceiver : MonoBehavour

{

    void OnEnable()

    {

        this.BindUntilDisable((string message) => { this.GetComponent().text = message; });

    }

}

```

## Sending Object

It's able to send any type of object.

```csharp

// Subscribe

this.BindUntilDisable((int value) => {});

this.BindUntilDisable((string value) => {});

this.BindUntilDisable((Person value) => {});

// Dispatch

Unibus.Dispatch(0);

Unibus.Dispatch("message");

Unibus.Dispatch(new Person("john", "due"));

```

## Tagging

Divide same type of object event by attaching tag.

```csharp

// Subscribe

this.BindUntilDisable("HP", (int value) => {});

this.BindUntilDisable("MP", (int value) => {});

// Dispatch

Unibus.Dispatch("HP", 100);

Unibus.Dispatch("MP", 200);

```

# License

[MIT](./LICENSE.md)