Class: CCar

Driveable car and mounted weapon holder.

Source

src/xrGame/CarScript.cpp, CCar binding.

Custom Constructor

CCar

Remarks

Vehicle and mounted-weapon holder APIs require a car object. Use game_object.get_car() or holder casts before calling these methods from shared object code.

Extends

• CGameObject

Implements

• holder

Constructors

Constructor

new CCar(): CCar;

Create a car object wrapper.

Returns

CCar

Overrides

CGameObject.constructor

Methods

_construct()

_construct(): DLL_Pure;

Construct engine-side object state.

Returns

DLL_Pure

Constructed base object.

Remarks

Lifecycle hook used by the engine. Calling it from gameplay scripts can reinitialize native state unexpectedly.

Inherited from

CGameObject._construct

---

Action()

Action(id: number, flags: number): void;

Send a mounted-weapon action.

Parameters

Parameter	Type	Description
id	number	Weapon action id.
flags	number	Action flags.

Returns

void

Remarks

For eWpnFire, eWpnActivate, and eWpnAutoFire, native code treats flags === 1 as enabled/start and any other value as disabled/stop. eWpnToDefaultDir resets the weapon direction to its bind orientation.

Implementation of

holder.Action

---

CanHit()

CanHit(): boolean;

Returns

boolean

Whether the mounted weapon can hit its current target.

---

CarExplode()

CarExplode(): void;

Trigger car explosion.

Returns

void

---

ChangefFuel()

ChangefFuel(fuel: number): void;

Change current fuel by a delta and clamp it to the tank range.

Parameters

Parameter	Type	Description
fuel	number	Fuel delta.

Returns

void

Since

OpenXRay 2024-08-09, e08b8073

Remarks

Negative deltas cannot reduce fuel below 0; positive deltas cannot increase it above GetfFuelTank(). Use SetfFuel() or set_fuel() when the script needs to assign an absolute fuel value.

---

ChangefHealth()

ChangefHealth(value: number): void;

Change vehicle health by a delta and clamp it to the normalized health range.

Parameters

Parameter	Type	Description
value	number	Health delta.

Returns

void

Since

OpenXRay 2024-08-09, e08b8073

Remarks

The native implementation clamps the result to 0..1. Use SetfHealth() when assigning an absolute health value.

---

CurrentVel()

CurrentVel(): vector;

Returns

vector

Current velocity vector.

---

engaged()

engaged(): boolean;

Returns

boolean

Whether the actor is currently attached to this holder.

Implementation of

holder.engaged

---

ExplodeTime()

ExplodeTime(): number;

Returns

number

Scheduled delayed-fuse explosion time in milliseconds, or 0 when no fuse was initialized.

---

FireDirDiff()

FireDirDiff(): number;

Returns

number

Difference between current and desired weapon fire direction.

---

get_fuel()

get_fuel(): number;

Returns

number

Amount of fuel in vehicle instance.

Since

OpenXRay 2026-01-01, e3b0e3c5, PR #2028

---

get_fuel_consumption()

get_fuel_consumption(): number;

Returns

number

Fuel consumption rate of vehicle instance.

Since

OpenXRay 2026-01-01, e3b0e3c5, PR #2028

---

get_fuel_tank()

get_fuel_tank(): number;

Returns

number

Fuel tank size.

Since

OpenXRay 2026-01-01, e3b0e3c5, PR #2028

---

getEnabled()

getEnabled(): boolean;

Returns

boolean

Whether the object is enabled in the client object loop.

Inherited from

CGameObject.getEnabled

---

GetfFuel()

GetfFuel(): number;

Returns

number

Amount of fuel in vehicle instance.

Since

OpenXRay 2024-08-09, e08b8073

---

GetfFuelConsumption()

GetfFuelConsumption(): number;

Returns

number

Fuel consumption rate of vehicle instance.

Since

OpenXRay 2024-08-09, e08b8073

---

GetfFuelTank()

GetfFuelTank(): number;

Returns

number

Fuel tank size (max possible amount of fuel at time).

Since

OpenXRay 2024-08-09, e08b8073

---

GetfHealth()

GetfHealth(): number;

Returns

number

Vehicle health value.

---

GetRPM()

GetRPM(): number;

Returns

number

Current vehicle RPM value (speed).

Since

OpenXRay 2024-08-09, e08b8073

---

getVisible()

getVisible(): boolean;

Returns

boolean

Whether the object is visible.

Inherited from

CGameObject.getVisible

---

HandBreak()

HandBreak(): void;

Set vehicle hand break in active state.

Returns

void

Since

OpenXRay 2024-08-09, e08b8073

---

HasWeapon()

HasWeapon(): boolean;

Returns

boolean

Whether vehicle has mounted weapon.

---

IsActiveEngine()

IsActiveEngine(): boolean;

Returns

boolean

Whether vehicle engine is active at the moment.

Since

OpenXRay 2024-08-09, e08b8073

---

IsObjectVisible()

IsObjectVisible(game_object: game_object): boolean;

Check whether an object is visible from the car weapon.

Parameters

Parameter	Type	Description
game_object	game_object	Object to test.

Returns

boolean

Whether the object is visible.

---

net_Export()

net_Export(net_packet: net_packet): void;

Export network state to a packet.

Parameters

Parameter	Type	Description
net_packet	net_packet	Destination network packet.

Returns

void

Inherited from

CGameObject.net_Export

---

net_Import()

net_Import(net_packet: net_packet): void;

Import network state from a packet.

Parameters

Parameter	Type	Description
net_packet	net_packet	Source network packet.

Returns

void

Inherited from

CGameObject.net_Import

---

net_Spawn()

net_Spawn(cse_abstract: cse_abstract): boolean;

Spawn the client object from its server object.

Parameters

Parameter	Type	Description
cse_abstract	cse_abstract	Server object used for spawn data.

Returns

boolean

Whether spawn succeeded.

Remarks

Lifecycle hook used during network spawn. Return false to reject spawn in custom subclasses.

Inherited from

CGameObject.net_Spawn

---

PlayDamageParticles()

PlayDamageParticles(): void;

Start car damage particles.

Returns

void

Since

OpenXRay 2024-08-09, e08b8073

---

ReleaseHandBreak()

ReleaseHandBreak(): void;

Deactivate vehicle hand break.

Returns

void

Since

OpenXRay 2024-08-09, e08b8073

---

set_fuel()

set_fuel(fuel: number): void;

Set current fuel amount directly.

Parameters

Parameter	Type	Description
fuel	number	Fuel amount.

Returns

void

Since

OpenXRay 2026-01-01, e3b0e3c5, PR #2028

Remarks

Lowercase alias for SetfFuel().

---

set_fuel_consumption()

set_fuel_consumption(consumption: number): void;

Set fuel consumption rate.

Parameters

Parameter	Type	Description
consumption	number	Fuel consumption rate.

Returns

void

Since

OpenXRay 2026-01-01, e3b0e3c5, PR #2028

---

set_fuel_tank()

set_fuel_tank(fuel: number): void;

Set fuel tank capacity.

Parameters

Parameter	Type	Description
fuel	number	Fuel tank capacity.

Returns

void

Since

OpenXRay 2026-01-01, e3b0e3c5, PR #2028

---

SetEnterLocked()

SetEnterLocked(is_enabled: boolean): void;

Lock or unlock entering the car.

Parameters

Parameter	Type	Description
is_enabled	boolean	Whether entering is locked.

Returns

void

Implementation of

holder.SetEnterLocked

---

SetExitLocked()

SetExitLocked(is_enabled: boolean): void;

Lock or unlock exiting the car.

Parameters

Parameter	Type	Description
is_enabled	boolean	Whether exiting is locked.

Returns

void

Implementation of

holder.SetExitLocked

---

SetExplodeTime()

SetExplodeTime(time: number): void;

Set delayed-fuse explosion time.

Parameters

Parameter	Type	Description
time	number	Explosion time in milliseconds.

Returns

void

Remarks

The native method accepts milliseconds and converts them to the delayed action fuse timeout.

---

SetfFuel()

SetfFuel(fuel: number): void;

Set current fuel amount directly.

Parameters

Parameter	Type	Description
fuel	number	Fuel amount.

Returns

void

Since

OpenXRay 2024-08-09, e08b8073

Remarks

This is an absolute setter and does not clamp against tank capacity.

---

SetfFuelConsumption()

SetfFuelConsumption(consumption: number): void;

Set fuel consumption rate.

Parameters

Parameter	Type	Description
consumption	number	Fuel consumption rate.

Returns

void

Since

OpenXRay 2024-08-09, e08b8073

---

SetfFuelTank()

SetfFuelTank(fuel: number): void;

Set fuel tank capacity.

Parameters

Parameter	Type	Description
fuel	number	Fuel tank capacity.

Returns

void

Since

OpenXRay 2024-08-09, e08b8073

---

SetfHealth()

SetfHealth(health: number): number;

Set vehicle health directly.

Parameters

Parameter	Type	Description
health	number	New health value.

Returns

number

Applied health value.

Remarks

This forwards to the entity health setter and returns the applied value. ChangefHealth() is the clamped delta helper.

---

SetParam()

Call Signature

SetParam(id: number, vector: vector): void;

Set a mounted-weapon vector parameter.

Parameters

Parameter	Type	Description
id	number	Weapon parameter id.
vector	vector	Parameter value.

Returns

void

Remarks

The script binding exposes the vector overload. Native code handles eWpnDesiredPos by aiming the weapon at the provided world position; other ids are ignored by this overload.

Implementation of

holder.SetParam

Call Signature

SetParam(id: 2, vector: vector): void;

Set mounted weapon desired target position.

Parameters

Parameter	Type	Description
id	2	CCar.eWpnDesiredPos.
vector	vector	Target world position.

Returns

void

Implementation of

holder.SetParam

---

SetRPM()

SetRPM(rpm: number): void;

Set current vehicle RPM value (speed).

Parameters

Parameter	Type	Description
rpm	number	RPM value to apply.

Returns

void

Since

OpenXRay 2024-08-09, e08b8073

---

StartEngine()

StartEngine(): void;

Start vehicle engine.

Returns

void

Since

OpenXRay 2024-08-09, e08b8073

---

StopDamageParticles()

StopDamageParticles(): void;

Stop car damage particles.

Returns

void

Since

OpenXRay 2024-08-09, e08b8073

---

StopEngine()

StopEngine(): void;

Stop vehicle engine.

Returns

void

Since

OpenXRay 2024-08-09, e08b8073

---

use()

use(object: CGameObject): boolean;

Use another object through the engine interaction path.

Parameters

Parameter	Type	Description
object	CGameObject	Object being used.

Returns

boolean

Whether the use action was handled.

Inherited from

CGameObject.use

---

Visual()

Visual(): IXR_IRender_Visual;

Returns

IXR_IRender_Visual

Render visual assigned to the object.

Inherited from

CGameObject.Visual

Properties

__name

readonly __name: string;

LuaBind instance constructor name.

Inherited from

CGameObject.__name

---

__name

readonly static __name: string;

LuaBind class constructor name.

Inherited from

CGameObject.__name

---

eWpnActivate

readonly static eWpnActivate: 3;

Engine enum value for CCar.eWpnActivate.

---

eWpnAutoFire

readonly static eWpnAutoFire: 5;

Engine enum value for CCar.eWpnAutoFire.

---

eWpnDesiredDir

readonly static eWpnDesiredDir: 1;

Engine enum value for CCar.eWpnDesiredDir.

---

eWpnDesiredPos

readonly static eWpnDesiredPos: 2;

Engine enum value for CCar.eWpnDesiredPos.

---

eWpnFire

readonly static eWpnFire: 4;

Engine enum value for CCar.eWpnFire.

---

eWpnToDefaultDir

readonly static eWpnToDefaultDir: 6;

Engine enum value for CCar.eWpnToDefaultDir.