Skip to main content

NetPlayer

This is the server-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
  • Get the NetPlayer from a PlayerClient using :GetNetPlayer()

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.

NetObjectBase:GetData(key: string): any​

Gets generic data from the object.

NetObjectBase:AsPlayer(): NetPlayer | nil​

Returns NetPlayer instance if the object is a player, nil otherwise.

NetObjectBase:AsVehicle(): NetVehicle | nil​

Returns NetVehicle instance if the object is a vehicle, nil otherwise.

NetObjectBase:GetType(): NetObjectType​

Returns the network object type. Use NetObjectType enum to compare types.

From NetObjectBase:

NetObjectBase:SetData(key: string, value: any, broadcast: bool): boolean​

Sets generic data on the object. Value must be a number, string, bool, vec2, vec3, vec4, or quat. If broadcast is true, the data will be synchronized to all clients. Returns true if the data was set successfully, false otherwise (for unsupported types).

Class Methods​

NetPlayer:Respawn(position: vec3, health: number, max_health: number)​

Respawns the player at the given position with the given health and max health.

Parameters:

  • position (vec3): The position to respawn the player at
  • health (number): The health to set for the respawned player
  • max_health (number): The maximum health to set for the respawned player

Example:

player:Respawn(vec3(0, 0, 0), 100, 100)

NetPlayer:GiveWeapon(string name, int ammo, WeaponSlot slot)​

Gives a weapon to the player with specified ammo count. View the full list of weapons here.

NetPlayer:RemoveWeapon(WeaponSlot slot)​

Removes a weapon from the specified weapon slot.