Version: 2017.3 (switch to 2018.1b)
LanguageEnglish
  • C#
  • JS

Script language

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

ClientCallbackAttribute

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, but not generate warnings.

This custom attribute is the same as the [Client] custom attribute, except that it does not generate a warning in the console if called on a server. This is useful to avoid spamming the console for functions that will be invoked by the engine, such as Update() or physics callbacks.

#pragma strict
public class Example extends MonoBehaviour {
    @ClientCallback
    function OnTriggerEnter2D(collider: Collider2D) {
        // make explosion
    }
}
using UnityEngine;
using UnityEngine.Networking;

public class Example : MonoBehaviour { [ClientCallback] void OnTriggerEnter2D(Collider2D collider) { // make explosion } }

This will make the explosion code only run when the trigger is hit on the client.

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