Controller for MmRelaySwitchNode. More...

Inheritance diagram for MercuryMessaging.MmSwitchResponder:

Public Member Functions
override void	Awake ()
	Auto-grabs the MmRelaySwitchNode. Also assigns/invokes Awake callbacks. More...

override void	Start ()
	Assign Global enter/exit Delegates for the MmRelaySwitchNode's FSM. More...

virtual void	OnMmSwitchNodeAwakeCompleteCallback ()
	Callback called after associated MmRelaySwitchNode awoken. More...

virtual void	OnMmNodeSwitchStartCompleteCallback ()
	Callback called after associated MmRelaySwitchNode started. More...

virtual void	MmSwitchSetup ()
	This is called when the MmNetworkResponder is started Important Note: this will only trigger locally. The reason for this is that the following code needs to execute on every instance of the MmRelayNode across the network Thus, in order to avoid triggering the message each time a client connects, we just trigger the message locally. More...

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

Public Attributes
string	InitialState
	Initial state for MmRelaySwitchNode FSM. More...

Protected Member Functions
override void	Switch (string iName)
	This responder will receive the switch message triggered by an MmInvoke. It will then trigger the jump state in the FSM of the associated MmRelaySwitchNode. More...

Protected Member Functions inherited from MercuryMessaging.MmBaseResponder
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...

Properties
MmRelaySwitchNode	MmRelaySwitchNode `[get]`
	Handle to MmRelaySwitchNode. More...

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

Controller for MmRelaySwitchNode.

Member Function Documentation

◆ Awake()

override void MercuryMessaging.MmSwitchResponder.Awake ( )

virtual

Auto-grabs the MmRelaySwitchNode. Also assigns/invokes Awake callbacks.

Reimplemented from MercuryMessaging.MmResponder.

◆ MmSwitchSetup()

virtual void MercuryMessaging.MmSwitchResponder.MmSwitchSetup ( )

virtual

This is called when the MmNetworkResponder is started Important Note: this will only trigger locally. The reason for this is that the following code needs to execute on every instance of the MmRelayNode across the network Thus, in order to avoid triggering the message each time a client connects, we just trigger the message locally.

◆ OnMmNodeSwitchStartCompleteCallback()

virtual void MercuryMessaging.MmSwitchResponder.OnMmNodeSwitchStartCompleteCallback ( )

virtual

Callback called after associated MmRelaySwitchNode started.

◆ OnMmSwitchNodeAwakeCompleteCallback()

virtual void MercuryMessaging.MmSwitchResponder.OnMmSwitchNodeAwakeCompleteCallback ( )

virtual

Callback called after associated MmRelaySwitchNode awoken.

◆ Start()

override void MercuryMessaging.MmSwitchResponder.Start ( )

virtual

Assign Global enter/exit Delegates for the MmRelaySwitchNode's FSM.

Reimplemented from MercuryMessaging.MmResponder.

◆ Switch()

override void MercuryMessaging.MmSwitchResponder.Switch ( string iName )

protectedvirtual

This responder will receive the switch message triggered by an MmInvoke. It will then trigger the jump state in the FSM of the associated MmRelaySwitchNode.

Parameters

iName Name of state to jump to.

Reimplemented from MercuryMessaging.MmBaseResponder.

Member Data Documentation

◆ InitialState

string MercuryMessaging.MmSwitchResponder.InitialState

Initial state for MmRelaySwitchNode FSM.

Property Documentation

◆ MmRelaySwitchNode

MmRelaySwitchNode MercuryMessaging.MmSwitchResponder.MmRelaySwitchNode

get

Handle to MmRelaySwitchNode.

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

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

Public Member Functions

Public Attributes

Protected Member Functions

Properties

Detailed Description

Member Function Documentation

◆ Awake()

◆ MmSwitchSetup()

◆ OnMmNodeSwitchStartCompleteCallback()

◆ OnMmSwitchNodeAwakeCompleteCallback()

◆ Start()

◆ Switch()

Member Data Documentation

◆ InitialState

Property Documentation

◆ MmRelaySwitchNode