Legacy Documentation: Version 2017.2 (Go to current version)
LanguageEnglish
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

ClientAttribute

class in UnityEngine.Networking

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Description

A Custom Attribute that can be added to member functions of NetworkBehaviour scripts, to make them only run on clients.

A [Client] method returns immediately if NetworkClient.active is not true, and generates a warning on the console. This attribute can be put on member functions that are meant to be only called on clients. This would redundant for [ClientRPC] functions, as being client-only is already enforced for them.

#pragma strict
public class Example extends MonoBehaviour {
    @Client
    public function OnClientDisconnected(conn: NetworkConnection, reader: NetworkReader) {
        Debug.Log("Client Disconnected");
        //ShutdownGame();
        Application.LoadLevel("title");
    }
}
using UnityEngine;
using UnityEngine.Networking;

public class Example : MonoBehaviour { [Client] public void OnClientDisconnected(NetworkConnection conn, NetworkReader reader) { Debug.Log("Client Disconnected"); //ShutdownGame(); Application.LoadLevel("title"); } }

Did you find this page useful? Please give it a rating: