 |
Mercury Messaging
Documentation for the Mercury Messaging Framework
|
|
Mercury Messaging
Documentation for the Mercury Messaging Framework
|
MmTaskResponder are MmBaseResponder that deal with IMmTaskInfos. Useful if you're trying to prepare MmBaseResponder derivations, but do not need to re-implement basic interaction with IMmTaskInfos More...
Public Member Functions | |
| virtual bool | TaskCompleteCheck () |
| Determine if the current task is complete. This class, which is intended to be used as a base class normally, will return false here. More... | |
| MmTaskResponder () | |
| MmTaskInfo constructed early to allow assignment through other GameObject awake calls if this responder's awake has not been called yet. More... | |
| override void | Awake () |
| Awake initializes completion state FSM More... | |
| virtual void | InitializeCompletionFSM () |
| Prepare the completion state FSM entry/exit delegates More... | |
| override void | Update () |
| Update method determines whether the task is complete by invoking TaskCompleteCheck() 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 | Start () |
| Start: Invokes MmOnStartComplete 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 | |
| FiniteStateMachine< TaskState > | TaskStateFSM |
| The completion FSM. Starts in a incomplete state and goes to complete when the task is complete. More... | |
Protected Attributes | |
| T | mmTaskInfo |
Properties | |
| T | MmTaskInfo [get] |
| The task info contains all details of a particular task. 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... | |
Additional Inherited Members | |
| Protected Member Functions inherited from MercuryMessaging.MmBaseResponder | |
| 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... | |
MmTaskResponder are MmBaseResponder that deal with IMmTaskInfos. Useful if you're trying to prepare MmBaseResponder derivations, but do not need to re-implement basic interaction with IMmTaskInfos
| T | Must implement IMmTaskInfo |
| T | : | IMmTaskInfo | |
| T | : | new() |
MmTaskInfo constructed early to allow assignment through other GameObject awake calls if this responder's awake has not been called yet.
|
virtual |
Awake initializes completion state FSM
Reimplemented from MercuryMessaging.MmResponder.
|
virtual |
Prepare the completion state FSM entry/exit delegates
|
virtual |
Determine if the current task is complete. This class, which is intended to be used as a base class normally, will return false here.
Reimplemented in MercuryMessaging.Task.MmTransformationTaskResponder< T >.
|
virtual |
Update method determines whether the task is complete by invoking TaskCompleteCheck()
Reimplemented from MercuryMessaging.MmResponder.
| FiniteStateMachine<TaskState> MercuryMessaging.Task.MmTaskResponder< T >.TaskStateFSM |
The completion FSM. Starts in a incomplete state and goes to complete when the task is complete.
|
get |
The task info contains all details of a particular task.
1.8.14