Version: 2017.1 (switch to 2017.2b)
LanguageEnglish
  • C#
  • JS

Script language

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

ClientRpcAttribute

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

This is an attribute that can be put on methods of NetworkBehaviour classes to allow them to be invoked on clients from a server.

[ClientRPC] functions are called by code on Unity Multiplayer servers, and then invoked on corresponding GameObjects on clients connected to the server. The arguments to the RPC call are serialized across the network, so that the client function is invoked with the same values as the function on the server. These functions must begin with the prefix "Rpc" and cannot be static.

#pragma strict
public class Example extends NetworkBehaviour {
    var counter: int;
    @ClientRpc
    public function RpcDoMagic(extra: int) {
        Debug.Log("Magic = " + (123 + extra));
    }
    function Update() {
        counter += 1;
        if (counter % 100 == 0 && NetworkServer.active) {
            RpcDoMagic(counter);
        }
    }
}
using UnityEngine;
using UnityEngine.Networking;

public class Example : NetworkBehaviour { int counter; [ClientRpc] public void RpcDoMagic(int extra) { Debug.Log("Magic = " + (123 + extra)); }

void Update() { counter += 1;

if (counter % 100 == 0 && NetworkServer.active) { RpcDoMagic(counter); } } }

The allowed argument types are;

• Basic type (byte, int, float, string, UInt64, etc)
• Built-in Unity math type (Vector3, Quaternion, etc),
• Arrays of basic types
• Structs containing allowable types
• NetworkIdentity
• NetworkInstanceId
• NetworkHash128
• GameObject with a NetworkIdentity component attached.

Variables

channelThe channel ID which this RPC transmission will use.