Language: English
  • C#
  • JS
  • Boo

Script language

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

NetworkView.RPC

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

Sumbission failed

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

Close

Cancel

Switch to Manual
public function RPC(name: string, mode: RPCMode, params args: object[]): void;
public void RPC(string name, RPCMode mode, params object[] args);
public def RPC(name as string, mode as RPCMode, *args as object[]) as void

Description

Call a RPC function on all connected peers.

The called function must have the @RPC tag set ([RPC] for C Sharp code). A NetworkView must be attached to the GameObject where the RPC function is being called. It doesn't matter if the NetworkView is being used for something else or just for the RPC function. If it is just for the RPC function, state synchronization should be turned off and the observed property can be set to none. RPC function names should be unique accross the scene, if two RPC functions in different scripts have the same name only one of them is called when RPC is invoked. RPC calls are always guaranteed to be executed in the same order as they are sent. The communication group set for the network view, with NetworkView.group, is used for the RPC call. To get information on the RPC itelf, you can add a NetworkMessageInfo parameter to the function declaration which will automatically contain the information. You don't need to change the way you call the RPC function when you do this. For more information see the RPC section of the manual. Valid RPC parameters are int, float, string, NetworkPlayer, NetworkViewID, Vector3 and Quaternion.

	var cubePrefab : Transform;
	function OnGUI () {
		if (GUILayout.Button("SpawnBox")) {
			var viewID : NetworkViewID= Network.AllocateViewID();
			networkView.RPC("SpawnBox", 
							RPCMode.AllBuffered, 
							viewID, 
							transform.position);	
		}
	}

@RPC function SpawnBox (viewID : NetworkViewID, location : Vector3) { // Instantate the prefab locally var clone : Transform; clone = Instantiate(cubePrefab, location, Quaternion.identity) as Transform; var nView : NetworkView; nView = clone.GetComponent(NetworkView); nView.viewID = viewID; }
using UnityEngine;
using System.Collections;

public class ExampleClass : MonoBehaviour {
    public Transform cubePrefab;
    void OnGUI() {
        if (GUILayout.Button("SpawnBox")) {
            NetworkViewID viewID = Network.AllocateViewID();
            networkView.RPC("SpawnBox", RPCMode.AllBuffered, viewID, transform.position);
        }
    }
    [RPC]
    void SpawnBox(NetworkViewID viewID, Vector3 location) {
        Transform clone;
        clone = Instantiate(cubePrefab, location, Quaternion.identity) as Transform as Transform;
        NetworkView nView;
        nView = clone.GetComponent<NetworkView>();
        nView.viewID = viewID;
    }
}
import UnityEngine
import System.Collections

public class ExampleClass(MonoBehaviour):

	public cubePrefab as Transform

	def OnGUI() as void:
		if GUILayout.Button('SpawnBox'):
			viewID as NetworkViewID = Network.AllocateViewID()
			networkView.RPC('SpawnBox', RPCMode.AllBuffered, viewID, transform.position)

	[RPC]
	def SpawnBox(viewID as NetworkViewID, location as Vector3) as void:
		clone as Transform
		clone = ((Instantiate(cubePrefab, location, Quaternion.identity) as Transform) as Transform)
		nView as NetworkView
		nView = clone.GetComponent[of NetworkView]()
		nView.viewID = viewID

public function RPC(name: string, target: NetworkPlayer, params args: object[]): void;
public void RPC(string name, NetworkPlayer target, params object[] args);
public def RPC(name as string, target as NetworkPlayer, *args as object[]) as void

Description

Call a RPC function on a specific player.