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.RemovePlayer

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 RemovePlayer(playerControllerId: short): bool;
public static bool RemovePlayer(short playerControllerId);

Parameters

id The local player ID number .

Returns

bool Returns true if the player was successfully destoyed and removed.

Description

Remove the specified player ID from the game.

Both the client and the server will destroy the player object and remove him from the player list.