Click or drag to resize

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 Hierarchy

Namespace:  ImmerseSDK.Multiplayer.Messaging
Assembly:  ImmerseSDK.App (in ImmerseSDK.App.dll) Version: 3.5.0.0 (3.5.0.0)
Syntax
C#
Copy
public class CustomMessageManager : SingletonBehaviour

The CustomMessageManager type exposes the following members.

Constructors
  NameDescription
Public methodCustomMessageManager
Initializes a new instance of the CustomMessageManager class
Top
Properties
  NameDescription
Public propertyIsPaused
Returns true is messages will be kept and not processed (paused state), or false if messages are being processed (unpaused state)
Top
Methods
  NameDescription
Public methodClearCustomMessageCallback
Clear a message callback for a custom message that was set up
Public methodCoroutineInitialise
Override this to perform initialisation tasks This coroutine is started in Awake(). To execute code in Awake(), override OnAwake()
(Overrides SingletonBehaviourCoroutineInitialise.)
Public methodDeleteAllMessages
Delete all custom and state synchroniser persisted messages
Protected methodOnAwake
Unity component method
(Overrides SingletonBehaviourOnAwake.)
Public methodProcessSavedMessages
Process messages that arrived before the receiver was ready
Public methodRegisterCustomMessageCallback
Register a message callback for a custom message that was set up
Public methodSendCustomMessage
Sends a custom message
Top
Extension Methods
  NameDescription
Public Extension MethodGetCopyOf
Copies all properties of a component from source to target. Uses reflection to set properties.
(Defined by ComponentExtensions.)
Public Extension MethodWaitForT
Waits for a singleton on a coroutine
(Defined by SingletonManager.)
Top
See Also