Legacy Documentation: Version 5.2
LanguageEnglish
  • C#
  • JS

Script language

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

ClientScene.AddPlayer

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 static function AddPlayer(readyConn: Networking.NetworkConnection, playerControllerId: short, extraMessage: Networking.MessageBase): bool;
public static bool AddPlayer(Networking.NetworkConnection readyConn, short playerControllerId, Networking.MessageBase extraMessage);
public static function AddPlayer(readyConn: Networking.NetworkConnection, playerControllerId: short): bool;
public static bool AddPlayer(Networking.NetworkConnection readyConn, short playerControllerId);
public static function AddPlayer(playerControllerId: short): bool;
public static bool AddPlayer(short playerControllerId);

Parameters

readyConn The connection to become ready for this client.
playerControllerId The local player ID number.
extraMessage An extra message object that can be passed to the server for this player.

Returns

bool True if player was added.

Description

This adds a player object for this client. This causes an AddPlayer message to be sent to the server, and NetworkManager.OnServerAddPlayer will be called. If an extra message was passed to AddPlayer, then OnServerAddPlayer will be called with a NetworkReader that contains the contents of the message.

The playerControllerId is the local player ID for the player, for example like which controller a player is using. This is not the global overall player number.

Copyright © 2015 Unity Technologies
Learn Community Asset Store Buy Download LegalPrivacy PolicyCookiesDo Not Sell or Share My Personal Information