A component that manages the process of a new host taking over a game when the old host is lost. This is referred to as "host migration". The migration manager sends information about each peer in the game to all the clients, and when the host is lost because of a crash or network outage, the clients are able to choose a new host, and continue the game.
The old host is able to rejoin the new game on the new host.
The state of SyncVars and SyncLists on all objects with NetworkIdentities in the scene is maintained during a host migration. This also applies to custom serialized data for objects.
All of the player objects in the game are disabled when the host is lost. Then, when the other clients rejoin the new game on the new host, the corresponding players for those clients are re-enabled on the host, and respawned on the other clients. No player state data is lost during a host migration.
This class provides a simple default UI for controlling the behaviour when the host is lost. The UI can be disabled with the showGUI property. There are a number of virtual functions that can be implemented to customize the behaviour of host migration.
Note that only data that is available to clients will be preserved during a host migration. If there is data that is only on the server, then it will not be available to the client that becomes the new host. This means data on the host that is not in SyncVars or SyncLists will not be available after a host migration.
The callback function OnStartServer is invoked for all networked objects when the client becomes a new host.
On the new host, the NetworkMigrationManager uses the function NetworkServer.BecomeNewHost() to construct a networked server scene from the state in the current ClientScene.
The peers in a game with host migration enabled are identified by their connectionId on the server. When a client reconnects to the new host of a game, this connectionId is passed to the new host so that it can match this client with the client that was connected to the old host. This Id is set on the ClientScene as the "reconnectId".
The old host of the game, the one that crashed or lost its network connection, can also reconnect to the new game as a client. This client uses the special ReconnectId of ClientScene.ReconnectIdHost (which is zero).
| client | The client instance that is being used to connect to the host. |
| disconnectedFromHost | True is this is a client that has been disconnected from a host. |
| hostMigration | Controls whether host migration is active. |
| hostWasShutdown | True if this was the host and the host has been shut down. |
| matchInfo | Information about the match. This may be null if there is no match. |
| newHostAddress | The IP address of the new host to connect to. |
| offsetX | The X offset in pixels of the migration manager default GUI. |
| offsetY | The Y offset in pixels of the migration manager default GUI. |
| oldServerConnectionId | The connectionId that this client was assign on the old host. |
| peers | The set of peers involved in the game. This includes the host and this client. |
| pendingPlayers | The player objects that have been disabled, and are waiting for their corresponding clients to reconnect. |
| showGUI | Flag to toggle display of the default UI. |
| waitingReconnectToNewHost | True if this is a client that was disconnected from the host and is now waiting to reconnect to the new host. |
| waitingToBecomeNewHost | True if this is a client that was disconnected from the host, and was chosen as the new host. |
| BecomeNewHost | This causes a client that has been disconnected from the host to become the new host of the game. |
| DisablePlayerObjects | This causes objects for known players to be disabled. |
| FindNewHost | This is a utility function to pick one of the peers in the game as the new host. |
| Initialize | Used to initialize the migration manager with client and match information. |
| LostHostOnClient | This should be called on a client when it has lost its connection to the host. |
| LostHostOnHost | This should be called on a host when it has has been shutdown. |
| ReconnectObjectForConnection | This re-establishes a non-player object with client authority with a client that is reconnected. It is similar to NetworkServer.SpawnWithClientAuthority(). |
| ReconnectPlayerForConnection | This re-establishes a player object with a client that is reconnected. It is similar to NetworkServer.AddPlayerForConnection(). The player game object will become the player object for the new connection. |
| Reset | Resets the migration manager, and sets the ClientScene's ReconnectId. |
| SendPeerInfo | This sends the set of peers in the game to all the peers in the game. |
| OnAuthorityUpdated | A virtual function that is called when the authority of a non-player object changes. |
| OnClientDisconnectedFromHost | A virtual function that is called when the client is disconnected from the host. |
| OnPeersUpdated | A virtual function that is called when the set of peers in the game changes. |
| OnServerHostShutdown | A virtual function that is called when the host is shutdown. |
| OnServerReconnectObject | A virtual function that is called for non-player objects with client authority on the new host when a client from the old host reconnects to the new host. |
| OnServerReconnectPlayer | A virtual function that is called on the new host when a client from the old host reconnects to the new host. |
| enabled | Enabled Behaviours are Updated, disabled Behaviours are not. |
| isActiveAndEnabled | Has the Behaviour had enabled called. |
| gameObject | The game object this component is attached to. A component is always attached to a game object. |
| tag | The tag of this game object. |
| transform | The Transform attached to this GameObject. |
| runInEditMode | Allow a specific instance of a MonoBehaviour to run in edit mode (only available in the editor). |
| useGUILayout | Disabling this lets you skip the GUI layout phase. |
| hideFlags | Should the object be hidden, saved with the scene or modifiable by the user? |
| name | The name of the object. |
| BroadcastMessage | Calls the method named methodName on every MonoBehaviour in this game object or any of its children. |
| CompareTag | Is this game object tagged with tag ? |
| GetComponent | Returns the component of Type type if the game object has one attached, null if it doesn't. |
| GetComponentInChildren | Returns the component of Type type in the GameObject or any of its children using depth first search. |
| GetComponentInParent | Returns the component of Type type in the GameObject or any of its parents. |
| GetComponents | Returns all components of Type type in the GameObject. |
| GetComponentsInChildren | Returns all components of Type type in the GameObject or any of its children. |
| GetComponentsInParent | Returns all components of Type type in the GameObject or any of its parents. |
| SendMessage | Calls the method named methodName on every MonoBehaviour in this game object. |
| SendMessageUpwards | Calls the method named methodName on every MonoBehaviour in this game object and on every ancestor of the behaviour. |
| CancelInvoke | Cancels all Invoke calls on this MonoBehaviour. |
| Invoke | Invokes the method methodName in time seconds. |
| InvokeRepeating | Invokes the method methodName in time seconds, then repeatedly every repeatRate seconds. |
| IsInvoking | Is any invoke on methodName pending? |
| StartCoroutine | Starts a coroutine. |
| StopAllCoroutines | Stops all coroutines running on this behaviour. |
| StopCoroutine | Stops the first coroutine named methodName, or the coroutine stored in routine running on this behaviour. |
| GetInstanceID | Returns the instance id of the object. |
| ToString | Returns the name of the game object. |
| Logs message to the Unity Console (identical to Debug.Log). | |
| Destroy | Removes a gameobject, component or asset. |
| DestroyImmediate | Destroys the object obj immediately. |
| DontDestroyOnLoad | Makes the object target not be destroyed automatically when loading a new scene. |
| FindObjectOfType | Returns the first active loaded object of Type type. |
| FindObjectsOfType | Returns a list of all active loaded objects of Type type. |
| Instantiate | Clones the object original and returns the clone. |
| bool | Does the object exist? |
| operator != | Compares if two objects refer to a different object. |
| operator == | Compares two object references to see if they refer to the same object. |
| Awake | Awake is called when the script instance is being loaded. |
| FixedUpdate | This function is called every fixed framerate frame, if the MonoBehaviour is enabled. |
| LateUpdate | LateUpdate is called every frame, if the Behaviour is enabled. |
| OnAnimatorIK | Callback for setting up animation IK (inverse kinematics). |
| OnAnimatorMove | Callback for processing animation movements for modifying root motion. |
| OnApplicationFocus | Sent to all GameObjects when the player gets or loses focus. |
| OnApplicationPause | Sent to all GameObjects when the application pauses. |
| OnApplicationQuit | Sent to all game objects before the application is quit. |
| OnAudioFilterRead | If OnAudioFilterRead is implemented, Unity will insert a custom filter into the audio DSP chain. |
| OnBecameInvisible | OnBecameInvisible is called when the renderer is no longer visible by any camera. |
| OnBecameVisible | OnBecameVisible is called when the renderer became visible by any camera. |
| OnCollisionEnter | OnCollisionEnter is called when this collider/rigidbody has begun touching another rigidbody/collider. |
| OnCollisionEnter2D | Sent when an incoming collider makes contact with this object's collider (2D physics only). |
| OnCollisionExit | OnCollisionExit is called when this collider/rigidbody has stopped touching another rigidbody/collider. |
| OnCollisionExit2D | Sent when a collider on another object stops touching this object's collider (2D physics only). |
| OnCollisionStay | OnCollisionStay is called once per frame for every collider/rigidbody that is touching rigidbody/collider. |
| OnCollisionStay2D | Sent each frame where a collider on another object is touching this object's collider (2D physics only). |
| OnConnectedToServer | Called on the client when you have successfully connected to a server. |
| OnControllerColliderHit | OnControllerColliderHit is called when the controller hits a collider while performing a Move. |
| OnDestroy | This function is called when the MonoBehaviour will be destroyed. |
| OnDisable | This function is called when the behaviour becomes disabled () or inactive. |
| OnDisconnectedFromServer | Called on the client when the connection was lost or you disconnected from the server. |
| OnDrawGizmos | Implement OnDrawGizmos if you want to draw gizmos that are also pickable and always drawn. |
| OnDrawGizmosSelected | Implement OnDrawGizmosSelected to draw a gizmo if the object is selected. |
| OnEnable | This function is called when the object becomes enabled and active. |
| OnFailedToConnect | Called on the client when a connection attempt fails for some reason. |
| OnFailedToConnectToMasterServer | Called on clients or servers when there is a problem connecting to the MasterServer. |
| OnGUI | OnGUI is called for rendering and handling GUI events. |
| OnJointBreak | Called when a joint attached to the same game object broke. |
| OnJointBreak2D | Called when a Joint2D attached to the same game object breaks. |
| OnMasterServerEvent | Called on clients or servers when reporting events from the MasterServer. |
| OnMouseDown | OnMouseDown is called when the user has pressed the mouse button while over the GUIElement or Collider. |
| OnMouseDrag | OnMouseDrag is called when the user has clicked on a GUIElement or Collider and is still holding down the mouse. |
| OnMouseEnter | Called when the mouse enters the GUIElement or Collider. |
| OnMouseExit | Called when the mouse is not any longer over the GUIElement or Collider. |
| OnMouseOver | Called every frame while the mouse is over the GUIElement or Collider. |
| OnMouseUp | OnMouseUp is called when the user has released the mouse button. |
| OnMouseUpAsButton | OnMouseUpAsButton is only called when the mouse is released over the same GUIElement or Collider as it was pressed. |
| OnNetworkInstantiate | Called on objects which have been network instantiated with Network.Instantiate. |
| OnParticleCollision | OnParticleCollision is called when a particle hits a Collider. |
| OnParticleTrigger | OnParticleTrigger is called when any particles in a particle system meet the conditions in the trigger module. |
| OnPlayerConnected | Called on the server whenever a new player has successfully connected. |
| OnPlayerDisconnected | Called on the server whenever a player disconnected from the server. |
| OnPostRender | OnPostRender is called after a camera finished rendering the scene. |
| OnPreCull | OnPreCull is called before a camera culls the scene. |
| OnPreRender | OnPreRender is called before a camera starts rendering the scene. |
| OnRenderImage | OnRenderImage is called after all rendering is complete to render image. |
| OnRenderObject | OnRenderObject is called after camera has rendered the scene. |
| OnSerializeNetworkView | Used to customize synchronization of variables in a script watched by a network view. |
| OnServerInitialized | Called on the server whenever a Network.InitializeServer was invoked and has completed. |
| OnTransformChildrenChanged | This function is called when the list of children of the transform of the GameObject has changed. |
| OnTransformParentChanged | This function is called when the parent property of the transform of the GameObject has changed. |
| OnTriggerEnter | OnTriggerEnter is called when the Collider other enters the trigger. |
| OnTriggerEnter2D | Sent when another object enters a trigger collider attached to this object (2D physics only). |
| OnTriggerExit | OnTriggerExit is called when the Collider other has stopped touching the trigger. |
| OnTriggerExit2D | Sent when another object leaves a trigger collider attached to this object (2D physics only). |
| OnTriggerStay | OnTriggerStay is called once per frame for every Collider other that is touching the trigger. |
| OnTriggerStay2D | Sent each frame where another object is within a trigger collider attached to this object (2D physics only). |
| OnValidate | This function is called when the script is loaded or a value is changed in the inspector (Called in the editor only). |
| OnWillRenderObject | OnWillRenderObject is called for each camera if the object is visible. |
| Reset | Reset to default values. |
| Start | Start is called on the frame when a script is enabled just before any of the Update methods is called the first time. |
| Update | Update is called every frame, if the MonoBehaviour is enabled. |