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

RemovePlayerMessage.playerControllerId

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 public short playerControllerId;

Description

The player ID of the player GameObject which should be removed.

This is specified by the client when they call NetworkClient.RemovePlayer(someId).

The HLAPI treats players and clients as separate GameObjects. In most cases, there is a single player for each client, but in some situations (for example, when there are multiple controllers connected to a console system) there might be multiple player GameObjects for a single connection. When there are multiple players for a single connection, use the playerControllerId property to tell them apart. This is an identifier that is scoped to the connection, so that it maps to the id of the controller associated with the player on that client.

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