Skip to main content

NetPlayer

This is the client-side class for NetPlayer. It has all the same methods and properties as the shared class, plus the following on this page.

Player Class Hierarchy

The diagram shows the inheritance hierarchy of player-related classes. To navigate between classes:

  • Get a PlayerClient using Players.Local()
  • Get the NetPlayer from a PlayerClient using :GetNetPlayer()
  • Get the Player from a NetPlayer using :GetGamePlayer()
  • Get the Character from a Player using :GetCharacter()

Class Instance Methods

Inherited Methods

From NetObjectBase:

NetObjectBase:GetPosition(): vec3

Returns the position of the object.

NetObjectBase:GetRotation(): vec3

Returns the rotation of the object.

NetObjectBase:GetHealth(): number

Returns the current health of the object.

NetObjectBase:GetMaxHealth(): number

Returns the maximum health of the object.

NetObjectBase:GetVelocity(): vec3

Returns the velocity of the object.

NetObjectBase:GetNetId(): number

Returns the network ID of the object.

Class Methods

NetPlayer:GetGamePlayer(): Player

Returns the Player associated with this NetPlayer.