Transport Class Reference

Native class for boats - handles physics simulation. More...

Protected Member Functions
override Shape	DebugFreeAreaAtDoor (int currentSeat, float maxAllowedObjHeight=0.5, float horizontalExtents=0.5, float playerHeight=1.7)
bool	DetectFlippedUsingWheels (VehicleFlippedContext ctx, bool disallowSide)
proto native float	EngineGetRPM ()
	Returns engine's rpm value.
proto native float	EngineGetRPM ()
	Returns engine's rpm value.
proto native float	EngineGetRPMIdle ()
	Returns engine's idle rpm before engine stalls.
proto native float	EngineGetRPMIdle ()
	Returns engine's idle rpm before engine stalls.
proto native float	EngineGetRPMMax ()
	Returns engine's max rpm before engine blows up.
proto native float	EngineGetRPMMax ()
	Returns engine's max rpm before engine blows up.
proto native float	EngineGetRPMMin ()
	Returns engine's min operating rpm.
proto native float	EngineGetRPMMin ()
	Returns engine's min operating rpm.
proto native float	EngineGetRPMRedline ()
	Returns engine's maximal working rpm without damaging the engine.
proto native float	EngineGetRPMRedline ()
	Returns engine's maximal working rpm without damaging the engine.
proto native bool	EngineIsOn ()
	Returns true when engine is running, false otherwise.
proto native bool	EngineIsOn ()
	Returns true when engine is running, false otherwise.
proto native void	EngineStart ()
	Starts the engine.
proto native void	EngineStart ()
	Starts the engine.
proto native void	EngineStop ()
	Stops the engine.
proto native void	EngineStop ()
	Stops the engine.
proto native void	Fill (BoatFluid fluid, float amount)
	Adds to the specified fluid the specified amount.
proto native void	Fill (CarFluid fluid, float amount)
	Adds to the specified fluid the specified amount.
proto native void	ForceDirection (vector dir)
proto native void	ForcePosition (vector pos)
proto native CarAutomaticGearboxMode	GearboxGetMode ()
	Returns gearbox mode. This is useful when car has automatic gearbox.
proto native CarGearboxType	GearboxGetType ()
	Returns gearbox type. See CarGearboxType enum for more info.
proto native float	GetBrake ()
	Returns the current brake value in range <0, 1>.
proto native int	GetClutch ()
	Returns the value of how much the clutch is disengaged.
proto native int	GetClutch ()
	Returns the value of how much the clutch is disengaged.
proto native CarController	GetController ()
proto native int	GetCurrentGear ()
	Returns the index of the current gear, -1 if there is no engine.
proto native int	GetCurrentGear ()
	Returns the index of the current gear, -1 if there is no engine.
proto native vector	GetEnginePos ()
	Get actual position of engine (model space).
proto native float	GetFluidCapacity (BoatFluid fluid)
	Returns tank capacity for the specified vehicle's fluid.
proto native float	GetFluidCapacity (CarFluid fluid)
	Returns tank capacity for the specified vehicle's fluid.
proto native float	GetFluidFraction (BoatFluid fluid)
	Returns fraction value (in range <0, 1>) of the current state of the specified vehicle's fluid.
proto native float	GetFluidFraction (CarFluid fluid)
	Returns fraction value (in range <0, 1>) of the current state of the specified vehicle's fluid.
proto native int	GetGear ()
	Returns the index of the future gear, -1 if there is no engine.
proto native int	GetGear ()
	Returns the index of the future gear, -1 if there is no engine.
proto native int	GetGearCount ()
	Returns the number of gears.
proto native int	GetGearCount ()
	Returns the number of gears.
proto native int	GetGearsCount ()
proto native float	GetHandbrake ()
	Returns the current handbrake value in range <0, 1>.
override event	GetMoveType ()
override event	GetMoveType ()
proto native int	GetNeutralGear ()
	Returns the index of the neutral gear.
proto native int	GetNeutralGear ()
	Returns the index of the neutral gear.
override event	GetOwnerStateType ()
override event	GetOwnerStateType ()
proto native float	GetSpeedometer ()
	Returns the current speed of the vehicle in km/h.
float	GetSpeedometerAbsolute ()
	Returns the current speed of the vehicle in km/h. Value is absolute.
proto native float	GetSteering ()
	Returns the actual steering value in range <-1, 1>.
proto native float	GetSteering ()
	Returns the current steering value in range <-1, 1>.
proto native float	GetThrottle ()
	Returns the actual throttle value in range <0, 1>.
proto native float	GetThrottle ()
	Returns the actual throttle value in range <0, 1>.
proto native float	GetThrust ()
proto native float	GetThrustGentle ()
proto native float	GetThrustTurbo ()
proto native bool	HasEngine ()
	Returns if there is an engine.
override bool	IsAreaAtDoorFree (int currentSeat, float maxAllowedObjHeight=0.5, float horizontalExtents=0.5, float playerHeight=1.7)
proto native void	Leak (BoatFluid fluid, float amount)
	Removes from the specified fluid the specified amount.
proto native void	Leak (CarFluid fluid, float amount)
	Removes from the specified fluid the specified amount.
proto native void	LeakAll (BoatFluid fluid)
	Removes all the specified fluid from vehicle.
proto native void	LeakAll (CarFluid fluid)
	Removes all the specified fluid from vehicle.
bool	OnBeforeEngineStart ()
	Is called every time the game wants to start the engine.
bool	OnBeforeEngineStart ()
	Is called every time the game wants to start the engine.
void	OnEngineStart ()
	Is called every time the engine starts.
void	OnEngineStart ()
	Is called every time the engine starts.
void	OnEngineStop ()
	Is called every time the engine stops.
void	OnEngineStop ()
	Is called every time the engine stops.
void	OnFluidChanged (BoatFluid fluid, float newValue, float oldValue)
	Is called every time when the specified vehicle's fluid level changes.
void	OnFluidChanged (CarFluid fluid, float newValue, float oldValue)
	Is called every time when the specified vehicle's fluid level changes.
void	OnGearChanged (int newGear, int oldGear)
	Is called every time when the simulation changed gear.
void	OnGearChanged (int newGear, int oldGear)
	Is called every time when the simulation changed gear.
float	OnSound (BoatSoundCtrl ctrl, float oldValue)
	Is called every sound simulation step.
float	OnSound (CarSoundCtrl ctrl, float oldValue)
	Is called every sound simulation step.
proto native float	PropellerGetAngularVelocity ()
	Returns the angular velocity of the propeller.
proto native vector	PropellerGetPosition ()
	Returns the propeller position in local space.
proto native void	SetBrake (float value, float unused0=0, bool unused1=false)
	Sets the future brake value.
proto native void	SetBrakesActivateWithoutDriver (bool activate=true)
	Sets if brakes should activate without a driver present.
proto native void	SetClutch (float value)
	Sets the future clutch value.
proto native void	SetClutch (float value)
	Sets the future clutch value.
proto native void	SetClutchState (bool in)
proto native void	SetEnginePos (vector pos)
	Override the position of engine (model space).
proto native void	SetHandbrake (float value)
	Sets the future handbrake value.
proto native void	SetSteering (float value)
	Sets the future steering value.
proto native void	SetSteering (float value, bool unused0=false)
	Sets the future steering value.
proto native void	SetThrottle (float value)
	Sets the future throttle value.
proto native void	SetThrottle (float value)
	Sets the future throttle value.
proto native void	SetThrust (float in, float gentle=0, float turbo=0)
proto native void	ShiftDown ()
	Shifts the future gear down, triggering gearbox simulation.
proto native void	ShiftDown ()
	Shifts the future gear down, triggering gearbox simulation.
proto native void	ShiftTo (int gear)
	Shifts the future gear to selected gear, triggering gearbox simulation.
proto native void	ShiftTo (int gear)
	Shifts the future gear to selected gear, triggering gearbox simulation.
proto native void	ShiftUp ()
	Shifts the future gear up, triggering gearbox simulation.
proto native void	ShiftUp ()
	Shifts the future gear up, triggering gearbox simulation.
proto native int	WheelCount ()
	How many wheel can be attached to a car (hubs only).
proto native int	WheelCountPresent ()
	Number of actually attached wheels (hubs only).
proto native float	WheelGetAngularVelocity (int wheelIdx)
	Returns the raw angular velocity of the wheel, unstable value.
proto native vector	WheelGetContactNormal (int wheelIdx)
	Returns the normal of contact in world space, only valid if there was an actual contact.
proto native vector	WheelGetContactPosition (int wheelIdx)
	Returns the position of contact in world space, only valid if there was an actual contact.
proto native vector	WheelGetDirection (int wheelIdx)
	Returns the direction pointing forwards that the wheel is facing.
proto native EntityAI	WheelGetEntity (int wheelIdx)
	Returns the entity attached that represents the wheel.
proto native SurfaceInfo	WheelGetSurface (int wheelIdx)
	Returns the surface that the wheel is nearby.
proto native CarWheelWaterState	WheelGetWaterState (int wheelIdx)
	Returns the state that the wheel is in with water.
proto native bool	WheelHasContact (int wheelIdx)
	Returns true if given wheel is making any contact.
proto native bool	WheelIsAnyLocked ()
	Returns true if any of the wheels are locked in terms of its movement.
proto native bool	WheelIsLocked (int wheelIdx)
	Returns true if given wheel is locked in terms of its movement.

Detailed Description

Native class for boats - handles physics simulation.

Native class for cars - handles physics simulation.

Definition at line 31 of file boat.c.

Member Function Documentation

DebugFreeAreaAtDoor()

override Shape DebugFreeAreaAtDoor ( int currentSeat, float maxAllowedObjHeight = 0.5, float horizontalExtents = 0.5, float playerHeight = 1.7 )

inlineprotected

Definition at line 140 of file car.c.

References ARGB(), Debug::DrawBox(), GetSpeedometerAbsolute(), IsAreaAtDoorFree(), and Shape.

DetectFlippedUsingWheels()

bool DetectFlippedUsingWheels ( VehicleFlippedContext ctx, bool disallowSide )

inlineprotected

Definition at line 168 of file car.c.

References vector::Dot(), vector::Up, WheelCount(), and WheelHasContact().

EngineGetRPM() [1/2]

proto native float EngineGetRPM ( )

protected

Returns engine's rpm value.

EngineGetRPM() [2/2]

proto native float EngineGetRPM ( )

protected

Returns engine's rpm value.

EngineGetRPMIdle() [1/2]

proto native float EngineGetRPMIdle ( )

protected

Returns engine's idle rpm before engine stalls.

EngineGetRPMIdle() [2/2]

proto native float EngineGetRPMIdle ( )

protected

Returns engine's idle rpm before engine stalls.

EngineGetRPMMax() [1/2]

proto native float EngineGetRPMMax ( )

protected

Returns engine's max rpm before engine blows up.

EngineGetRPMMax() [2/2]

proto native float EngineGetRPMMax ( )

protected

Returns engine's max rpm before engine blows up.

EngineGetRPMMin() [1/2]

proto native float EngineGetRPMMin ( )

protected

Returns engine's min operating rpm.

EngineGetRPMMin() [2/2]

proto native float EngineGetRPMMin ( )

protected

Returns engine's min operating rpm.

EngineGetRPMRedline() [1/2]

proto native float EngineGetRPMRedline ( )

protected

Returns engine's maximal working rpm without damaging the engine.

EngineGetRPMRedline() [2/2]

proto native float EngineGetRPMRedline ( )

protected

Returns engine's maximal working rpm without damaging the engine.

EngineIsOn() [1/2]

proto native bool EngineIsOn ( )

protected

Returns true when engine is running, false otherwise.

EngineIsOn() [2/2]

proto native bool EngineIsOn ( )

protected

Returns true when engine is running, false otherwise.

EngineStart() [1/2]

proto native void EngineStart ( )

protected

Starts the engine.

EngineStart() [2/2]

proto native void EngineStart ( )

protected

Starts the engine.

EngineStop() [1/2]

proto native void EngineStop ( )

protected

Stops the engine.

EngineStop() [2/2]

proto native void EngineStop ( )

protected

Stops the engine.

Fill() [1/2]

proto native void Fill ( BoatFluid fluid, float amount )

protected

Adds to the specified fluid the specified amount.

Fill() [2/2]

proto native void Fill ( CarFluid fluid, float amount )

protected

Adds to the specified fluid the specified amount.

ForceDirection()

proto native void ForceDirection ( vector dir )

protected

ForcePosition()

proto native void ForcePosition ( vector pos )

protected

GearboxGetMode()

proto native CarAutomaticGearboxMode GearboxGetMode ( )

protected

Returns gearbox mode. This is useful when car has automatic gearbox.

GearboxGetType()

proto native CarGearboxType GearboxGetType ( )

protected

Returns gearbox type. See CarGearboxType enum for more info.

GetBrake()

proto native float GetBrake ( )

protected

Returns the current brake value in range <0, 1>.

GetClutch() [1/2]

proto native int GetClutch ( )

protected

Returns the value of how much the clutch is disengaged.

GetClutch() [2/2]

proto native int GetClutch ( )

protected

Returns the value of how much the clutch is disengaged.

GetController()

proto native CarController GetController ( )

protected

GetCurrentGear() [1/2]

proto native int GetCurrentGear ( )

protected

Returns the index of the current gear, -1 if there is no engine.

GetCurrentGear() [2/2]

proto native int GetCurrentGear ( )

protected

Returns the index of the current gear, -1 if there is no engine.

GetEnginePos()

proto native vector GetEnginePos ( )

protected

Get actual position of engine (model space).

GetFluidCapacity() [1/2]

proto native float GetFluidCapacity ( BoatFluid fluid )

protected

Returns tank capacity for the specified vehicle's fluid.

Parameters

fluid

the specified fluid type

GetFluidCapacity() [2/2]

proto native float GetFluidCapacity ( CarFluid fluid )

protected

Returns tank capacity for the specified vehicle's fluid.

Parameters

fluid

the specified fluid type

GetFluidFraction() [1/2]

proto native float GetFluidFraction ( BoatFluid fluid )

protected

Returns fraction value (in range <0, 1>) of the current state of the specified vehicle's fluid.

Parameters

[in]

fluid

the specified fluid type

GetFluidFraction() [2/2]

proto native float GetFluidFraction ( CarFluid fluid )

protected

Returns fraction value (in range <0, 1>) of the current state of the specified vehicle's fluid.

Parameters

[in]

fluid

the specified fluid type

GetGear() [1/2]

proto native int GetGear ( )

protected

Returns the index of the future gear, -1 if there is no engine.

GetGear() [2/2]

proto native int GetGear ( )

protected

Returns the index of the future gear, -1 if there is no engine.

GetGearCount() [1/2]

proto native int GetGearCount ( )

protected

Returns the number of gears.

GetGearCount() [2/2]

proto native int GetGearCount ( )

protected

Returns the number of gears.

GetGearsCount()

proto native int GetGearsCount ( )

protected

GetHandbrake()

proto native float GetHandbrake ( )

protected

Returns the current handbrake value in range <0, 1>.

GetMoveType() [1/2]

override event GetMoveType ( )

inlineprotected

Definition at line 40 of file boat.c.

GetMoveType() [2/2]

override event GetMoveType ( )

inlineprotected

Definition at line 107 of file car.c.

GetNeutralGear() [1/2]

proto native int GetNeutralGear ( )

protected

Returns the index of the neutral gear.

GetNeutralGear() [2/2]

proto native int GetNeutralGear ( )

protected

Returns the index of the neutral gear.

GetOwnerStateType() [1/2]

override event GetOwnerStateType ( )

inlineprotected

Definition at line 34 of file boat.c.

GetOwnerStateType() [2/2]

override event GetOwnerStateType ( )

inlineprotected

Definition at line 101 of file car.c.

GetSpeedometer()

proto native float GetSpeedometer ( )

protected

Returns the current speed of the vehicle in km/h.

Referenced by GetSpeedometerAbsolute().

GetSpeedometerAbsolute()

float GetSpeedometerAbsolute ( )

inlineprotected

Returns the current speed of the vehicle in km/h. Value is absolute.

Definition at line 116 of file car.c.

References Math::AbsFloat(), and GetSpeedometer().

Referenced by DebugFreeAreaAtDoor(), and IsAreaAtDoorFree().

GetSteering() [1/2]

proto native float GetSteering ( )

protected

Returns the actual steering value in range <-1, 1>.

GetSteering() [2/2]

proto native float GetSteering ( )

protected

Returns the current steering value in range <-1, 1>.

GetThrottle() [1/2]

proto native float GetThrottle ( )

protected

Returns the actual throttle value in range <0, 1>.

GetThrottle() [2/2]

proto native float GetThrottle ( )

protected

Returns the actual throttle value in range <0, 1>.

GetThrust()

proto native float GetThrust ( )

protected

GetThrustGentle()

proto native float GetThrustGentle ( )

protected

GetThrustTurbo()

proto native float GetThrustTurbo ( )

protected

HasEngine()

proto native bool HasEngine ( )

protected

Returns if there is an engine.

IsAreaAtDoorFree()

override bool IsAreaAtDoorFree ( int currentSeat, float maxAllowedObjHeight = 0.5, float horizontalExtents = 0.5, float playerHeight = 1.7 )

inlineprotected

Definition at line 121 of file car.c.

References GetSpeedometerAbsolute(), and IsAreaAtDoorFree().

Referenced by ActionGetInTransport::ActionCondition(), ActionGetOutTransport::ActionCondition(), EntityAI::DebugFreeAreaAtDoor(), DebugFreeAreaAtDoor(), EntityAI::IsAreaAtDoorFree(), and IsAreaAtDoorFree().

Leak() [1/2]

proto native void Leak ( BoatFluid fluid, float amount )

protected

Removes from the specified fluid the specified amount.

Leak() [2/2]

proto native void Leak ( CarFluid fluid, float amount )

protected

Removes from the specified fluid the specified amount.

LeakAll() [1/2]

proto native void LeakAll ( BoatFluid fluid )

protected

Removes all the specified fluid from vehicle.

LeakAll() [2/2]

proto native void LeakAll ( CarFluid fluid )

protected

Removes all the specified fluid from vehicle.

OnBeforeEngineStart() [1/2]

bool OnBeforeEngineStart ( )

inlineprotected

Is called every time the game wants to start the engine.

Returns

true if the engine can start, false otherwise.

Definition at line 146 of file boat.c.

OnBeforeEngineStart() [2/2]

bool OnBeforeEngineStart ( )

inlineprotected

Is called every time the game wants to start the engine.

Returns

true if the engine can start, false otherwise.

Definition at line 383 of file car.c.

OnEngineStart() [1/2]

void OnEngineStart ( )

inlineprotected

Is called every time the engine starts.

Definition at line 155 of file boat.c.

OnEngineStart() [2/2]

void OnEngineStart ( )

inlineprotected

Is called every time the engine starts.

Definition at line 392 of file car.c.

OnEngineStop() [1/2]

void OnEngineStop ( )

inlineprotected

Is called every time the engine stops.

Definition at line 160 of file boat.c.

OnEngineStop() [2/2]

void OnEngineStop ( )

inlineprotected

Is called every time the engine stops.

Definition at line 397 of file car.c.

OnFluidChanged() [1/2]

void OnFluidChanged ( BoatFluid fluid, float newValue, float oldValue )

inlineprotected

Is called every time when the specified vehicle's fluid level changes.

This callback is called on owner only.

Parameters

[in]

fluid

fluid identifier,

See also

BoatFluid

Parameters

[in]	newValue	new fluid level
[in]	oldValue	previous fluid level before change

Definition at line 178 of file boat.c.

OnFluidChanged() [2/2]

void OnFluidChanged ( CarFluid fluid, float newValue, float oldValue )

inlineprotected

Is called every time when the specified vehicle's fluid level changes.

This callback is called on owner only.

Parameters

[in]

fluid

fluid identifier,

See also

CarFluid

Parameters

[in]	newValue	new fluid level
[in]	oldValue	previous fluid level before change

Definition at line 417 of file car.c.

OnGearChanged() [1/2]

void OnGearChanged ( int newGear, int oldGear )

inlineprotected

Is called every time when the simulation changed gear.

Parameters

[in]	newGear	new gear level
[in]	oldGear	previous gear level before gear shift

Definition at line 168 of file boat.c.

OnGearChanged() [2/2]

void OnGearChanged ( int newGear, int oldGear )

inlineprotected

Is called every time when the simulation changed gear.

Parameters

[in]	newGear	new gear level
[in]	oldGear	previous gear level before gear shift

Definition at line 405 of file car.c.

OnSound() [1/2]

float OnSound ( BoatSoundCtrl ctrl, float oldValue )

inlineprotected

Is called every sound simulation step.

In this callback, user can modify behaviour of sound controllers.

Parameters

[in]

ctrl

sound controller identifier,

See also

BoatSoundCtrl

Parameters

[in]

oldValue

already computed value by the game code

Returns

new value of the specified sound controller.

Definition at line 188 of file boat.c.

OnSound() [2/2]

float OnSound ( CarSoundCtrl ctrl, float oldValue )

inlineprotected

Is called every sound simulation step.

In this callback, user can modify behaviour of sound controllers.

Parameters

[in]

ctrl

sound controller identifier,

See also

CarSoundCtrl

Parameters

[in]

oldValue

already computed value by the game code

Returns

new value of the specified sound controller.

Definition at line 427 of file car.c.

PropellerGetAngularVelocity()

proto native float PropellerGetAngularVelocity ( )

protected

Returns the angular velocity of the propeller.

PropellerGetPosition()

proto native vector PropellerGetPosition ( )

protected

Returns the propeller position in local space.

SetBrake()

proto native void SetBrake ( float value, float unused0 = 0, bool unused1 = false )

protected

Sets the future brake value.

SetBrakesActivateWithoutDriver()

proto native void SetBrakesActivateWithoutDriver ( bool activate = true )

protected

Sets if brakes should activate without a driver present.

SetClutch() [1/2]

proto native void SetClutch ( float value )

protected

Sets the future clutch value.

SetClutch() [2/2]

proto native void SetClutch ( float value )

protected

Sets the future clutch value.

SetClutchState()

proto native void SetClutchState ( bool in )

protected

SetEnginePos()

proto native void SetEnginePos ( vector pos )

protected

Override the position of engine (model space).

SetHandbrake()

proto native void SetHandbrake ( float value )

protected

Sets the future handbrake value.

SetSteering() [1/2]

proto native void SetSteering ( float value )

protected

Sets the future steering value.

SetSteering() [2/2]

proto native void SetSteering ( float value, bool unused0 = false )

protected

Sets the future steering value.

SetThrottle() [1/2]

proto native void SetThrottle ( float value )

protected

Sets the future throttle value.

SetThrottle() [2/2]

proto native void SetThrottle ( float value )

protected

Sets the future throttle value.

SetThrust()

proto native void SetThrust ( float in, float gentle = 0, float turbo = 0 )

protected

ShiftDown() [1/2]

proto native void ShiftDown ( )

protected

Shifts the future gear down, triggering gearbox simulation.

ShiftDown() [2/2]

proto native void ShiftDown ( )

protected

Shifts the future gear down, triggering gearbox simulation.

ShiftTo() [1/2]

proto native void ShiftTo ( int gear )

protected

Shifts the future gear to selected gear, triggering gearbox simulation.

References gear.

ShiftTo() [2/2]

proto native void ShiftTo ( int gear )

protected

Shifts the future gear to selected gear, triggering gearbox simulation.

References gear.

ShiftUp() [1/2]

proto native void ShiftUp ( )

protected

Shifts the future gear up, triggering gearbox simulation.

ShiftUp() [2/2]

proto native void ShiftUp ( )

protected

Shifts the future gear up, triggering gearbox simulation.

WheelCount()

proto native int WheelCount ( )

protected

How many wheel can be attached to a car (hubs only).

Referenced by DetectFlippedUsingWheels().

WheelCountPresent()

proto native int WheelCountPresent ( )

protected

Number of actually attached wheels (hubs only).

WheelGetAngularVelocity()

proto native float WheelGetAngularVelocity ( int wheelIdx )

protected

Returns the raw angular velocity of the wheel, unstable value.

Parameters

[in]

wheelIdx

index of the wheel, they are counted from left-front to rear-right

WheelGetContactNormal()

proto native vector WheelGetContactNormal ( int wheelIdx )

protected

Returns the normal of contact in world space, only valid if there was an actual contact.

Parameters

[in]

wheelIdx

index of the wheel, they are counted from left-front to rear-right

WheelGetContactPosition()

proto native vector WheelGetContactPosition ( int wheelIdx )

protected

Returns the position of contact in world space, only valid if there was an actual contact.

Parameters

[in]

wheelIdx

index of the wheel, they are counted from left-front to rear-right

WheelGetDirection()

proto native vector WheelGetDirection ( int wheelIdx )

protected

Returns the direction pointing forwards that the wheel is facing.

Parameters

[in]

wheelIdx

index of the wheel, they are counted from left-front to rear-right

WheelGetEntity()

proto native EntityAI WheelGetEntity ( int wheelIdx )

protected

Returns the entity attached that represents the wheel.

Parameters

[in]

wheelIdx

index of the wheel, they are counted from left-front to rear-right

WheelGetSurface()

proto native SurfaceInfo WheelGetSurface ( int wheelIdx )

protected

Returns the surface that the wheel is nearby.

Parameters

[in]

wheelIdx

index of the wheel, they are counted from left-front to rear-right

WheelGetWaterState()

proto native CarWheelWaterState WheelGetWaterState ( int wheelIdx )

protected

Returns the state that the wheel is in with water.

Parameters

[in]

wheelIdx

index of the wheel, they are counted from left-front to rear-right

WheelHasContact()

proto native bool WheelHasContact ( int wheelIdx )

protected

Returns true if given wheel is making any contact.

Parameters

[in]

wheelIdx

index of the wheel, they are counted from left-front to rear-right

Referenced by DetectFlippedUsingWheels().

WheelIsAnyLocked()

proto native bool WheelIsAnyLocked ( )

protected

Returns true if any of the wheels are locked in terms of its movement.

WheelIsLocked()

proto native bool WheelIsLocked ( int wheelIdx )

protected

Returns true if given wheel is locked in terms of its movement.

Parameters

[in]

wheelIdx

index of the wheel, they are counted from left-front to rear-right

---

The documentation for this class was generated from the following files:

• F:/Games/Dayz/scripts/3_game/vehicles/boat.c
• F:/Games/Dayz/scripts/3_game/vehicles/car.c