Legacy Documentation: Version 5.3
LanguageEnglish
  • C#
  • JS

Script language

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

NetworkServer.ReplacePlayerForConnection

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

public static function ReplacePlayerForConnection(conn: Networking.NetworkConnection, player: GameObject, playerControllerId: short): bool;
public static bool ReplacePlayerForConnection(Networking.NetworkConnection conn, GameObject player, short playerControllerId);

Parameters

conn Connection which is adding the player.
player Player object spawned for the player.
playerControllerId The player controller ID number as specified by client.

Returns

bool True if player was replaced.

Description

This replaces the player object for a connection with a different player object. The old player object is not destroyed.

If a connection already has a player object, this can be used to replace that object with a different player object. This does NOT change the ready state of the connection, so it can safely be used while changin scenes.