 | CustomMessageManager Class |
Manager class to help with object state synchronisation and custom message setup.
Object state synchronisation is intended to be a simpler way to use custom messages with less setup.
You can still use custom messages by setting them up manually in the Editor.
Inheritance HierarchySystemObject
UnityEngine.Object
UnityEngine.Component
UnityEngine.Behaviour
UnityEngine.MonoBehaviour
ImmerseSDKLoggingBehaviour
ImmerseSDKSingletonBehaviour
ImmerseSDK.Multiplayer.MessagingCustomMessageManager
UnityEngine.Object
UnityEngine.Component
UnityEngine.Behaviour
UnityEngine.MonoBehaviour
ImmerseSDKLoggingBehaviour
ImmerseSDKSingletonBehaviour
ImmerseSDK.Multiplayer.MessagingCustomMessageManager
Namespace: ImmerseSDK.Multiplayer.Messaging
Assembly: ImmerseSDK.App (in ImmerseSDK.App.dll) Version: 3.9.0.0 (3.9.0.0)
SyntaxC#
public class CustomMessageManager : SingletonBehaviour
The CustomMessageManager type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | CustomMessageManager | Initializes a new instance of the CustomMessageManager class |
Properties| Name | Description | |
|---|---|---|
 | IsPaused |
Returns true is messages will be kept and not processed (paused state), or false if messages are being processed (unpaused state)
|
Methods| Name | Description | |
|---|---|---|
| ClearCustomMessageCallback |
Clear a message callback for a custom message that was set up
|
| CoroutineInitialise |
Override this to perform initialisation tasks
This coroutine is started in Awake().
To execute code in Awake(), override OnAwake()
(Overrides SingletonBehaviourCoroutineInitialise.) |
| DeleteAllMessages |
Delete all custom and state synchroniser persisted messages
|
| DeleteMessage |
Delete a specific persisted message
|
 | IsMessageTypeValid |
Returns true if message ID is within the valid range
|
 | OnAwake |
Unity component method
(Overrides SingletonBehaviourOnAwake.) |
| ProcessSavedMessages |
Process messages that arrived before the receiver was ready
|
| RegisterCustomMessageCallback |
Register a message callback for a custom message that was set up
|
| SendCustomMessage(UInt16, Byte) |
Sends a custom message
|
| SendCustomMessage(UInt16, Object) |
Sends a custom message
|
| SendCustomMessage(UInt16, String) |
Sends a custom message
|
| SendCustomMessage(UInt16, Byte, MessageID) |
Sends a custom message
|
| SendCustomMessage(UInt16, Object, MessageID) |
Sends a custom message with a message id. This is required for persisting messages
|
| SendCustomMessage(UInt16, String, MessageID) |
Sends a custom message with a message id. This is required for persisting messages
|
Extension Methods| Name | Description | |
|---|---|---|
 | GetCopyOf |
Copies all properties of a component from source to target. Uses reflection to set properties.
(Defined by ComponentExtensions.) |
| WaitForT |
Waits for a singleton on a coroutine
(Defined by SingletonManager.) |
See Also