Base implmentation of IMmResponder. More...

Inheritance diagram for MercuryMessaging.MmResponder:

Public Member Functions
virtual void	Awake ()
	Awake: Invokes MmOnAwakeComplete More...

virtual void	Start ()
	Start: Invokes MmOnStartComplete More...

virtual void	Update ()
	Base Update of MmResponder Derived classes should always override. More...

virtual 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...

virtual 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...

virtual 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...

virtual 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...

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

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

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

MmTag	Tag `[get, set]`
	MmTags allow you to specify filters for execution in Mercury XM graphs. More...

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

Properties inherited from MercuryMessaging.IMmResponder
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

Base implmentation of IMmResponder.

Member Function Documentation

◆ Awake()

virtual void MercuryMessaging.MmResponder.Awake ( )

virtual

Awake: Invokes MmOnAwakeComplete

Reimplemented in MercuryMessaging.MmRelayNode, MercuryMessaging.Task.MmTaskManager< U >, MercuryMessaging.Task.MmTaskResponder< T >, MercuryMessaging.MmRelaySwitchNode, MercuryMessaging.MmSwitchResponder, MercuryMessaging.AppState.MmRelayAppStateNode, and MercuryMessaging.Support.GUI.MmGuiResponder.

◆ GetRelayNode()

abstract MmRelayNode MercuryMessaging.MmResponder.GetRelayNode ( )

pure virtual

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

Returns: an MmRelayNode sharing the GameObject with the instance.

Implements MercuryMessaging.IMmResponder.

Implemented in MercuryMessaging.MmRelayNode, and MercuryMessaging.MmBaseResponder.

◆ MmInvoke()

virtual void MercuryMessaging.MmResponder.MmInvoke	(	MmMessageType	msgType,
		MmMessage	message
	)

virtual

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.

Implements MercuryMessaging.IMmResponder.

Reimplemented in MercuryMessaging.MmRelayNode, InvocationComparison, MercuryMessaging.MmBaseResponder, and MercuryMessaging.MmQuickNode.

◆ MmOnAwakeComplete()

virtual void MercuryMessaging.MmResponder.MmOnAwakeComplete ( )

virtual

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.

Implements MercuryMessaging.IMmResponder.

◆ MmOnStartComplete()

virtual void MercuryMessaging.MmResponder.MmOnStartComplete ( )

virtual

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.

Implements MercuryMessaging.IMmResponder.

◆ MmRegisterAwakeCompleteCallback()

virtual void MercuryMessaging.MmResponder.MmRegisterAwakeCompleteCallback ( IMmCallback callback )

virtual

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.

Implements MercuryMessaging.IMmResponder.

◆ MmRegisterStartCompleteCallback()

virtual void MercuryMessaging.MmResponder.MmRegisterStartCompleteCallback ( IMmCallback callback )

virtual

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.

Implements MercuryMessaging.IMmResponder.

◆ Start()

virtual void MercuryMessaging.MmResponder.Start ( )

virtual

Start: Invokes MmOnStartComplete

Reimplemented in MercuryMessaging.MmRelayNode, MercuryMessaging.Task.MmTaskManager< U >, MercuryMessaging.MmRelaySwitchNode, MercuryMessaging.MmSwitchResponder, InvocationComparison, MercuryMessaging.AppState.MmAppStateSwitchResponder, MercuryMessaging.Tutorials.Tutorial1.TestScript, and LightSwitchResponder.

◆ Update()

virtual void MercuryMessaging.MmResponder.Update ( )

virtual

Base Update of MmResponder Derived classes should always override.

Reimplemented in MercuryMessaging.Task.MmTaskResponder< T >, InvocationComparison, and MercuryMessaging.MmTransformResponder.

Property Documentation

◆ MmGameObject

GameObject MercuryMessaging.MmResponder.MmGameObject

get

Handle to an instance's GameObject.

◆ Tag

MmTag MercuryMessaging.MmResponder.Tag

getset

MmTags allow you to specify filters for execution in Mercury XM graphs.

◆ TagCheckEnabled

bool MercuryMessaging.MmResponder.TagCheckEnabled

getset

Determines whether tag checking is enabled for this IMmResponder

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

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

Public Member Functions

Properties

Detailed Description

Member Function Documentation

◆ Awake()

◆ GetRelayNode()

◆ MmInvoke()

◆ MmOnAwakeComplete()

◆ MmOnStartComplete()

◆ MmRegisterAwakeCompleteCallback()

◆ MmRegisterStartCompleteCallback()

◆ Start()

◆ Update()

Property Documentation

◆ MmGameObject

◆ Tag

◆ TagCheckEnabled