Class PlayerController

This represents a networked player.

Inheritance

System.Object

PlayerController

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: UnityEngine.Networking

Syntax

[Obsolete("The high level API classes are deprecated and will be removed in the future.")]
public class PlayerController

Constructors

PlayerController()

Declaration

public PlayerController()

Fields

gameObject

The game object for this player.

Declaration

public GameObject gameObject

Field Value

Type	Description
GameObject

MaxPlayersPerClient

The maximum number of local players that a client connection can have.

Declaration

public const int MaxPlayersPerClient = 32

Field Value

Type	Description
System.Int32

playerControllerId

The local player ID number of this player.

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.

Declaration

public short playerControllerId

Field Value

Type	Description
System.Int16

unetView

The NetworkIdentity component of the player.

Declaration

public NetworkIdentity unetView

Field Value

Type	Description
NetworkIdentity

Properties

IsValid

Checks if this PlayerController has an actual player attached to it.

Declaration

public bool IsValid { get; }

Property Value

Type	Description
System.Boolean

Methods

ToString()

String representation of the player objects state.

Declaration

public override string ToString()

Returns

Type	Description
System.String	String with the object state.

Overrides

System.Object.ToString()