The core of MercuryMessaging. This interface specifies MmInvoke - which is the message-passing utility of the framework. Awake/Start callbacks are also required to allow the framework to ensure certain components are in place (in both networked and local environments) when needed. More...

Inheritance diagram for MercuryMessaging.IMmResponder:

Public Member Functions
void	MmOnAwakeComplete ()
	Post Awake callback used between objects implementing this interface. This allows for initialization steps that must occur before one instance's Awake and its Start. More...

void	MmOnStartComplete ()
	Post Start callback used between objects implementing this interface This allows for initialization steps that must occur before one instance's Start and its first Update. More...

void	MmRegisterAwakeCompleteCallback (IMmCallback callback)
	It is possible that certain handles are not going to be in-place when registration of the OnAwakeComplete callback is invoked. The is especially true in scenarios where MmRelayNodes are networked. This allows for a deferred registration, eliminating most instances where the Awake callback invocations fail. More...

void	MmRegisterStartCompleteCallback (IMmCallback callback)
	It is possible that certain handles are not going to be in-place when registration of the OnStartComplete callback is invoked. The is especially true in scenarios where MmRelayNodes are networked. This allows for a deferred registration, eliminating most instances where the Start callback invocations fail. More...

void	MmInvoke (MmMessageType msgType, MmMessage message)
	Invoke an MmMethod. More...

MmRelayNode	GetRelayNode ()
	Get a handle to a IMmResponder's MmRelayNode, if one is present. More...

Properties
MmTag	Tag `[get, set]`
	MmTags allow you to specify filters for execution in MercuryMessaging Hierarchies. MmTag More...

GameObject	MmGameObject `[get]`
	Handle to an instance's GameObject. More...

bool	TagCheckEnabled `[get, set]`
	Determines whether tag checking is enabled for this IMmResponder More...

Detailed Description

The core of MercuryMessaging. This interface specifies MmInvoke - which is the message-passing utility of the framework. Awake/Start callbacks are also required to allow the framework to ensure certain components are in place (in both networked and local environments) when needed.

Member Function Documentation

◆ GetRelayNode()

MmRelayNode MercuryMessaging.IMmResponder.GetRelayNode ( )

Get a handle to a IMmResponder's MmRelayNode, if one is present.

Returns: an MmRelayNode sharing the GameObject with the instance.

Implemented in MercuryMessaging.MmRelayNode, MercuryMessaging.MmBaseResponder, and MercuryMessaging.MmResponder.

◆ MmInvoke()

void MercuryMessaging.IMmResponder.MmInvoke	(	MmMessageType	msgType,
		MmMessage	message
	)

Invoke an MmMethod.

Parameters

msgType	Type of message. This specifies the type of the payload. This is important in networked scenarios, when proper deseriaization into the correct type requires knowing what was used to serialize the object originally.
message	The message to send. This class builds on UNET's MessageBase so it is Auto [de]serialized by UNET.

Implemented in MercuryMessaging.MmRelayNode, InvocationComparison, MercuryMessaging.MmResponder, MercuryMessaging.MmBaseResponder, and MercuryMessaging.MmQuickNode.

◆ MmOnAwakeComplete()

void MercuryMessaging.IMmResponder.MmOnAwakeComplete ( )

Post Awake callback used between objects implementing this interface. This allows for initialization steps that must occur before one instance's Awake and its Start.

Implemented in MercuryMessaging.MmResponder.

◆ MmOnStartComplete()

void MercuryMessaging.IMmResponder.MmOnStartComplete ( )

Post Start callback used between objects implementing this interface This allows for initialization steps that must occur before one instance's Start and its first Update.

Implemented in MercuryMessaging.MmResponder.

◆ MmRegisterAwakeCompleteCallback()

void MercuryMessaging.IMmResponder.MmRegisterAwakeCompleteCallback ( IMmCallback callback )

It is possible that certain handles are not going to be in-place when registration of the OnAwakeComplete callback is invoked. The is especially true in scenarios where MmRelayNodes are networked. This allows for a deferred registration, eliminating most instances where the Awake callback invocations fail.

Parameters

callback Callback to be registered.

Implemented in MercuryMessaging.MmResponder.

◆ MmRegisterStartCompleteCallback()

void MercuryMessaging.IMmResponder.MmRegisterStartCompleteCallback ( IMmCallback callback )

It is possible that certain handles are not going to be in-place when registration of the OnStartComplete callback is invoked. The is especially true in scenarios where MmRelayNodes are networked. This allows for a deferred registration, eliminating most instances where the Start callback invocations fail.

Parameters

callback Callback to be registered.

Implemented in MercuryMessaging.MmResponder.

Property Documentation

◆ MmGameObject

GameObject MercuryMessaging.IMmResponder.MmGameObject

get

Handle to an instance's GameObject.

◆ Tag

MmTag MercuryMessaging.IMmResponder.Tag

getset

MmTags allow you to specify filters for execution in MercuryMessaging Hierarchies. MmTag

◆ TagCheckEnabled

bool MercuryMessaging.IMmResponder.TagCheckEnabled

getset

Determines whether tag checking is enabled for this IMmResponder

The documentation for this interface was generated from the following file:

C:/Users/ce223/Documents/Projects/MercuryMessaging/Assets/MercuryMessaging/Protocol/IMmResponder.cs

Public Member Functions

Properties

Detailed Description

Member Function Documentation

◆ GetRelayNode()

◆ MmInvoke()

◆ MmOnAwakeComplete()

◆ MmOnStartComplete()

◆ MmRegisterAwakeCompleteCallback()

◆ MmRegisterStartCompleteCallback()

Property Documentation

◆ MmGameObject

◆ Tag

◆ TagCheckEnabled