Class MessageBus

Namespace

Termule.Engine.Core

Assembly

Termule.Engine.dll

A hub for subscribing to and sending messages between objects.

public class MessageBus : GameElement

Inheritance

object

GameElement

MessageBus

Derived

LocalMessageBus

Inherited Members

GameElement.Game

GameElement.Activated

GameElement.World

GameElement.Systems

GameElement.Activate()

GameElement.Deactivate()

GameElement.GetRequiredSystem<TSystem>()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Methods

Broadcast(object)

Send a message to its subscribed listeners on this bus.

public void Broadcast(object message)

Parameters

message object

The message to send.

SubscribeAll(IMessageListenerBase)

Register the listener to receive all types of messages that it implements IMessageListener<TMessage> for.

public void SubscribeAll(IMessageListenerBase listener)

Parameters

listener IMessageListenerBase

The listener to subscribe.

Subscribe<TMessage>(IMessageListener<TMessage>)

Register the listener to receive the specified type of message.

public void Subscribe<TMessage>(IMessageListener<TMessage> listener)

Parameters

listener IMessageListener<TMessage>

The listener to subscribe.

Type Parameters

TMessage

The type of message to subscribe to.

Unsubscribe<TMessage>(IMessageListener<TMessage>)

Unregister the listener from receiving the specified type of message.

public void Unsubscribe<TMessage>(IMessageListener<TMessage> listener)

Parameters

listener IMessageListener<TMessage>

The listener to unsubscribe.

Type Parameters

TMessage

The type of message to unsubscribe from.

UnsusbcribeAll(IMessageListenerBase)

Unregisters the listener from receiving all types of messages.

public void UnsusbcribeAll(IMessageListenerBase listener)

Parameters

listener IMessageListenerBase

The listener to subscribe.