Lifecycle of a GameObject

Networked GameObjects go through several lifecycle states. You can add custom logic to the object lifecycle events by subscribing to the corresponding event in NetworkIdentity

Spawning

Server	Client
Instantiate
Start Server
NetworkWorld.onSpawn
	Instantiate
	StartAuthority
	StartClient
	StartLocalPlayer
	NetworkWorld.onSpawn

Destroying

Server	Client
NetworkWorld.onUnspawn
	StopAuthority
	StopClient
	Destroy
	NetworkWorld.onUnspawn
StopServer
Destroy

note

In Mirror and UNet, you can add logic to lifecycle events by overriding methods in NetworkBehaviour.
In Mirage you do it by subscribing to events in NetworkIdentity

Server Instantiate

This is usually done by you using Unity's GameObject.Instantiate This goes through the regular GameObject Lifecycle events such as Awake, Start, Enabled, etc... Basically this is outside Mirage's control.

Scene Objects are normally instantiated as part of the scene.

Server Start

To start a server object, spawn it. If you wish to perform some logic when the object starts in the server, add a component in your gameObject with our own method and subscribe to NetworkIdentity.OnStartServer

For example:

public class MyComponent : MonoBehaviour
{
    public void Awake() 
    {
        GetComponent<NetworkIdentity>.OnStartServer.AddListener(OnStartServer);
    }

    public void OnStartServer() 
    {
        Debug.Log("The object started on the server")
    }
}

You can also simply drag your OnStartServer method in the NetworkIdentity.OnStartServer event in the inspector.

During the spawn, a message will be sent to all the clients telling them to spawn the object. The message will include all the data in SyncVars, SyncLists, SyncHashSet, SyncDictionary

NetworkWorld onSpawn and onUnspawn

The NetworkWorld class is what holds the list of all spawned Identities. This class is used for both server and client, and can be found on NetworkServer.World and NetworkClient.World.

NetworkWorld has event that are called when Network objects are spawned or unspawn, they can be used when you need to do this on all network objects, but dont want to add listeners to each one individually.

public class MyComponent : MonoBehaviour  
{
    public NetworkServer Server;
    public NetworkClient Client;

    public void Awake() 
    {
        // Client/Server.World is only set after server is started, 
        // so wait for start, then add event listener to OnSpawn
        Server.Started.AddListener(ServerStarted);
        Client.Started.AddListener(ClientStarted);
    }

    private void ServerStarted() 
    {
        Server.World.onSpawn += OnServerSpawn;
        Server.World.onUnspawn += OnServerUnspawn;
    }
    private void OnServerSpawn(NetworkIdentity identity) 
    {
        Debug.Log($"The object {identity} was spawned on the server");
    }
    private void OnServerUnspawn(NetworkIdentity identity) 
    {
        Debug.Log($"The object {identity} was unspawned on the server");
    }

    private void ClientStarted() 
    {
        Client.World.onSpawn += OnClientSpawn;
        Client.World.onUnspawn += OnClientUnspawn;
    }
    private void OnClientSpawn(NetworkIdentity identity) 
    {
        Debug.Log($"The object {identity} was spawned on the client");
    }
    private void OnClientUnspawn(NetworkIdentity identity) 
    {
        Debug.Log($"The object {identity} was unspawned on the client");
    }
}

Client Instantiate

When an object is spawned, the server will send a message to the clients telling it to spawn a GameObject and provide an asset id.

By default, Mirage will look up all the known prefabs looking for that asset id.
Make sure to add your prefabs to the NetworkClient list of prefabs. Then Mirage will instantiate the prefab, and it will go through the regular Unity Lifecycle events. You can customize how objects are instantiated using Spawn Handlers.

Do not add Network logic to these events. Instead, use these events to subscribe to network events in NetworkIdentity.

Immediately after the object is instantiated, all the data is updated to match the data in the server.

Client Start Authority

If the object is owned by this client, then NetworkIdentity will invoke the NetworkIdentity.OnAuthorityChanged Subscribe to this event either by using AddListener, or adding your method to the event in the inspector. Note the Authority can be revoked, and granted again. Every time the client gains authority, this event will be invoked again.

Start Client

The event NetworkIdentity.OnStartClient will be invoked. Subscribe to this event by using AddListener or adding your method in the event in the inspector

Start Local Player

If the object spawned is the character object, the event NetworkIdentity.OnStartLocalPlayer is invoked. Subscribe to this event by using AddListener or adding your method in the event in the inspector

Stop Authority

If the object loses authority over the object, then NetworkIdentity will invoke the NetworkIdentity.OnAuthorityChanged Subscribe to this event either by using AddListener, or adding your method to the event in the inspector. Note the Authority can be revoked, and granted again. Every time the client loses authority, this event will be invoked again.

Server Stop

Either because the client disconnected, the server stopped, you called ServerObjectManager.Destroy(GameObject, Boolean) the object may stop in the server. During this state, a message is sent to all the clients to unspawn the object. The event NetworkIdentity.OnStopServer will be invoked.

Subscribe to this event either by using AddListener, or by adding your method to the event in the inspector.

Server Destroy

By default, the server will call GameObject.Destroy to destroy the object.
Note that if it is a Scene Object the server will invoke GameObject.SetActive(false) instead.

The regular unity lifecycle events apply.

Note that the server will destroy the object, and will not wait for the clients to unspawn their objects.

Stop Client

This can be triggered either because the client received an Unspawn message or the client was disconnected The event NetworkIdentity.OnStopClient will be invoked.
Subscribe to this event either by using AddListener, or by adding your method to the event in the inspector.

Use it to clean up any network-related resource used by this object.

Client Destroy

After an object is stopped on the client, by default unity will call GameObject.Destroy if it is a prefab Spawned Object Or it will call GameObject.SetActive(false) if it is a Scene Object You can customize how objects are destroying using Spawn Handlers

The normal Unity lifecycle events still apply.