Giter VIP home page Giter VIP logo

ansible-events's Introduction

Ansible Events

A Pub/Sub Event Aggregator for Unity. It's really an "anything" aggregator, but it's very useful for aggregating events so they can be subscribed and published to without the subscriber and publisher directly referencing each other.

There are 3 different types of events included:

  • AnsibleEventSync
  • AnsibleEventAsync
  • AnsibleEventCoroutine

Defining Custom Events

Namespace for defining events:

using AnsibleEvents.Events;

Defining an event:

public class MySyncEventWithNoParameters : AnsibleEventSync {}

AnsibleEventSync and AnsibleEventAsync events can also be defined with 1-4 parameters:

public class MySyncEventWithFourParameters : AnisbleEventSync<bool, int, float, string> {}

AnsibleEventCoroutine events can't be defined with parameters because coroutine methods can't receive arguments:

public class MyCoroutineEvent : AnsibleEventCoroutine {}

Consuming Events

Namespace for getting and consuming events:

using AnsibleEvents;

Subscribe to an event:

Ansible.Get<MyEvent>().Subscribe(SomeMethod);

Unsubscribe from an event:

Ansible.Get<MyEvent>().Unsubscribe(SomeMethod);

Publish an event:

Ansible.Get<MyEvent>().Publish(SomeValue);

Example

Consuming within a MonoBehaviour:

private void OnEnable()
{
    Ansible.Get<MyEvent>().Subscribe(OnMyEvent);
}

private void OnDisable()
{
    Ansible.Get<MyEvent>().Unsubscribe(OnMyEvent);    
}

private void OnMyEvent()
{
    Debug.Log("MyEvent was Published");
}

Publishing within a MonoBehaviour:

private void Update()
{
    if(Time.frameCount % 60 == 0)
    {
        Ansible.Get<MyEvent>().Publish();
    }
}

ansible-events's People

Contributors

zacharysnewman avatar semantic-release-bot avatar

Stargazers

John Rush avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.