Version: 2018.3 (switch to 2019.1b or 2017.4)
LanguageEnglish
  • C#
Method group is Obsolete

TargetRpcAttribute

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

Obsolete

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. Unlike the ClientRpc attribute, these functions are invoked on one individual target client, not all of the ready clients.

[TargetRpc] functions are called by user code on the server, and then invoked on the corresponding client object on the client of the specified NetworkConnection. 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 "Target" and cannot be static.

The first argument to an TargetRpc function must be a NetworkConnection object.

using UnityEngine;
using UnityEngine.Networking;

public class Example : NetworkBehaviour { [TargetRpc] public void TargetDoMagic(NetworkConnection target, int extra) { Debug.Log("Magic = " + (123 + extra)); }

[Command] void CmdTest() { TargetDoMagic(connectionToClient, 55); } }

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.

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