MmResponder that implements a switch handling the framework-provided MmMethods. More...

Inheritance diagram for MercuryMessaging.MmBaseResponder:

Public Member Functions
override void	MmInvoke (MmMessageType msgType, MmMessage message)
	Invoke an MmMethod. Implements a switch that handles the different MmMethods defined by default set in MmMethod MmMethod More...

virtual void	SetActive (bool active)
	Handle MmMethod: SetActive More...

virtual void	Initialize ()
	Handle MmMethod: Initialize Initialize allows you to provide additional initialization logic in-between calls to Monobehavior provided Awake() and Start() calls. More...

virtual void	Refresh (List< MmTransform > transformList)
	Handle MmMethod: Refresh More...

override MmRelayNode	GetRelayNode ()
	Implementation of IMmResponder's GetRelayNode. More...

Public Member Functions inherited from MercuryMessaging.MmResponder
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...

Protected Member Functions
virtual void	Switch (string iName)
	Handle MmMethod: Switch More...

virtual void	Complete (bool active)
	Handle MmMethod: Switch More...

virtual void	ApplyTaskInfo (IMmSerializable serializableValue)
	Handle MmMethod: TaskInfo Given a IMmSerializable, extract TaskInfo. More...

virtual void	ReceivedMessage (MmMessage message)
	Handle MmMethod: Base MmMessage. Override this to handle base Mercury Messages. More...

virtual void	ReceivedMessage (MmMessageBool message)
	Handle MmMethod: MessageBool. Override this to handle Mercury's bool messages. More...

virtual void	ReceivedMessage (MmMessageByteArray message)
	Handle MmMethod: MessageByteArray. Override this to handle Mercury's byte array messages. More...

virtual void	ReceivedMessage (MmMessageFloat message)
	Handle MmMethod: MessageFloat. Override this to handle Mercury's float messages. More...

virtual void	ReceivedMessage (MmMessageInt message)
	Handle MmMethod: MessageInt. Override this to handle Mercury's int messages. More...

virtual void	ReceivedMessage (MmMessageSerializable message)
	Handle MmMethod: MessageSerializable. Override this to handle Mercury's serializable messages. More...

virtual void	ReceivedMessage (MmMessageString message)
	Handle MmMethod: MessageString Override this to handle Mercury's string messages. More...

virtual void	ReceivedMessage (MmMessageTransform message)
	Handle MmMethod: MessageTransform Override this to handle Mercury's transform messages. More...

virtual void	ReceivedMessage (MmMessageTransformList message)
	Handle MmMethod: MessageTransformList Override this to handle Mercury's transform list messages. More...

virtual void	ReceivedMessage (MmMessageVector3 message)
	Handle MmMethod: MessageVector3 Override this to handle Mercury's Vector3 messages. More...

virtual void	ReceivedMessage (MmMessageVector4 message)
	Handle MmMethod: MessageVector4 Override this to handle Mercury's Vector4 messages. More...

Additional Inherited Members
Properties inherited from MercuryMessaging.MmResponder
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

MmResponder that implements a switch handling the framework-provided MmMethods.

Member Function Documentation

◆ ApplyTaskInfo()

virtual void MercuryMessaging.MmBaseResponder.ApplyTaskInfo ( IMmSerializable serializableValue )

protectedvirtual

Handle MmMethod: TaskInfo Given a IMmSerializable, extract TaskInfo.

Parameters

serializableValue Serializable class containing MmTask Info

◆ Complete()

virtual void MercuryMessaging.MmBaseResponder.Complete ( bool active )

protectedvirtual

Handle MmMethod: Switch

Parameters

active Can be used to indicate active state of object that triggered complete message

◆ GetRelayNode()

override MmRelayNode MercuryMessaging.MmBaseResponder.GetRelayNode ( )

virtual

Implementation of IMmResponder's GetRelayNode.

Returns: Returns MmRelayNode if one attached to GameObject, Otherwise returns NULL.

Implements MercuryMessaging.MmResponder.

◆ Initialize()

virtual void MercuryMessaging.MmBaseResponder.Initialize ( )

virtual

Handle MmMethod: Initialize Initialize allows you to provide additional initialization logic in-between calls to Monobehavior provided Awake() and Start() calls.

Reimplemented in MercuryMessaging.Tutorials.Tutorial1.TestScript, and MercuryMessaging.Tutorials.Tutorial1.Sphere1Controller.

◆ MmInvoke()

override void MercuryMessaging.MmBaseResponder.MmInvoke	(	MmMessageType	msgType,
		MmMessage	message
	)

virtual

Invoke an MmMethod. Implements a switch that handles the different MmMethods defined by default set in MmMethod 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. MmMessageType
message	The message to send. This class builds on UNET's MessageBase so it is Auto [de]serialized by UNET. MmMessage

Reimplemented from MercuryMessaging.MmResponder.

Reimplemented in InvocationComparison.

◆ ReceivedMessage() [1/11]

virtual void MercuryMessaging.MmBaseResponder.ReceivedMessage ( MmMessage message )

protectedvirtual

Handle MmMethod: Base MmMessage. Override this to handle base Mercury Messages.

Parameters

message MmMessage

◆ ReceivedMessage() [2/11]

virtual void MercuryMessaging.MmBaseResponder.ReceivedMessage ( MmMessageBool message )

protectedvirtual

Handle MmMethod: MessageBool. Override this to handle Mercury's bool messages.

Parameters

message MmMessageBool

◆ ReceivedMessage() [3/11]

virtual void MercuryMessaging.MmBaseResponder.ReceivedMessage ( MmMessageByteArray message )

protectedvirtual

Handle MmMethod: MessageByteArray. Override this to handle Mercury's byte array messages.

Parameters

message MmMessageByteArray

◆ ReceivedMessage() [4/11]

virtual void MercuryMessaging.MmBaseResponder.ReceivedMessage ( MmMessageFloat message )

protectedvirtual

Handle MmMethod: MessageFloat. Override this to handle Mercury's float messages.

Parameters

message MmMessageFloat

◆ ReceivedMessage() [5/11]

virtual void MercuryMessaging.MmBaseResponder.ReceivedMessage ( MmMessageInt message )

protectedvirtual

Handle MmMethod: MessageInt. Override this to handle Mercury's int messages.

Parameters

message MmMessageInt

◆ ReceivedMessage() [6/11]

virtual void MercuryMessaging.MmBaseResponder.ReceivedMessage ( MmMessageSerializable message )

protectedvirtual

Handle MmMethod: MessageSerializable. Override this to handle Mercury's serializable messages.

Parameters

message MmMessageSerializable

◆ ReceivedMessage() [7/11]

virtual void MercuryMessaging.MmBaseResponder.ReceivedMessage ( MmMessageString message )

protectedvirtual

Handle MmMethod: MessageString Override this to handle Mercury's string messages.

Parameters

message MmMessageString

Reimplemented in MercuryMessaging.Support.GUI.MmGuiResponder.

◆ ReceivedMessage() [8/11]

virtual void MercuryMessaging.MmBaseResponder.ReceivedMessage ( MmMessageTransform message )

protectedvirtual

Handle MmMethod: MessageTransform Override this to handle Mercury's transform messages.

Parameters

message MmMessageTransform

Reimplemented in MercuryMessaging.MmTransformResponder.

◆ ReceivedMessage() [9/11]

virtual void MercuryMessaging.MmBaseResponder.ReceivedMessage ( MmMessageTransformList message )

protectedvirtual

Handle MmMethod: MessageTransformList Override this to handle Mercury's transform list messages.

Parameters

message MmMessageTransformList

◆ ReceivedMessage() [10/11]

virtual void MercuryMessaging.MmBaseResponder.ReceivedMessage ( MmMessageVector3 message )

protectedvirtual

Handle MmMethod: MessageVector3 Override this to handle Mercury's Vector3 messages.

Parameters

message MmMessageVector3

◆ ReceivedMessage() [11/11]

virtual void MercuryMessaging.MmBaseResponder.ReceivedMessage ( MmMessageVector4 message )

protectedvirtual

Handle MmMethod: MessageVector4 Override this to handle Mercury's Vector4 messages.

Parameters

message MmMessageVector4

◆ Refresh()

virtual void MercuryMessaging.MmBaseResponder.Refresh ( List< MmTransform > transformList )

virtual

Handle MmMethod: Refresh

Parameters

transformList List of transforms needed in refreshing an MmResponder.

◆ SetActive()

virtual void MercuryMessaging.MmBaseResponder.SetActive ( bool active )

virtual

Handle MmMethod: SetActive

Parameters

active Value of active state.

Reimplemented in MercuryMessaging.Support.GUI.MmGuiResponder, LightSwitchResponder, and LightGUIResponder.

◆ Switch()

virtual void MercuryMessaging.MmBaseResponder.Switch ( string iName )

protectedvirtual

Handle MmMethod: Switch

Parameters

iName Name of value in which to active.

Reimplemented in MercuryMessaging.MmSwitchResponder.

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

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

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ ApplyTaskInfo()

◆ Complete()

◆ GetRelayNode()

◆ Initialize()

◆ MmInvoke()

◆ ReceivedMessage() [1/11]

◆ ReceivedMessage() [2/11]

◆ ReceivedMessage() [3/11]

◆ ReceivedMessage() [4/11]

◆ ReceivedMessage() [5/11]

◆ ReceivedMessage() [6/11]

◆ ReceivedMessage() [7/11]

◆ ReceivedMessage() [8/11]

◆ ReceivedMessage() [9/11]

◆ ReceivedMessage() [10/11]

◆ ReceivedMessage() [11/11]

◆ Refresh()

◆ SetActive()

◆ Switch()