Skip to main content

NetVehicle

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

Vehicle-related APIs. To use these, you must first have a reference to a NetVehicle, such as from a player's vehicle or from world vehicles.

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:SetData(key: string, value: any): boolean​

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

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 NetVehicle:

NetVehicle:GetId(): number​

Returns the ID of the vehicle.

Class Methods

NetVehicle:GI(): Vehicle​

Returns the game instance (GI) of the NetVehicle, which is a Vehicle.