Base native class for all motorized wheeled vehicles. More...
Private Member Functions | |
protected override event | GetOwnerStateType () |
protected override event | GetMoveType () |
proto native float | GetThrottle () |
Returns the actual throttle value in range <0, 1>. | |
proto native void | SetThrottle (float value) |
Sets the future throttle value. | |
proto native float | GetSteering () |
Returns the actual steering value in range <-1, 1>. | |
proto native void | SetSteering (float value) |
Sets the future steering value. | |
proto native int | GetGearCount () |
Returns the number of gears. | |
proto native int | GetNeutralGear () |
Returns the index of the neutral gear. | |
proto native int | GetGear () |
Returns the index of the future 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 int | GetClutch () |
Returns the value of how much the clutch is disengaged. | |
proto native void | ShiftUp () |
Shifts the future gear up, triggering gearbox simulation. | |
proto native void | ShiftTo (int gear) |
Shifts the future gear to selected gear, triggering gearbox simulation. | |
proto native void | ShiftDown () |
Shifts the future gear down, triggering gearbox simulation. | |
proto native bool | HasEngine () |
Returns if there is an engine. | |
proto native float | EngineGetRPMMin () |
Returns engine's min operating rpm. | |
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 | EngineGetRPMRedline () |
Returns engine's maximal working rpm without damaging the engine. | |
proto native float | EngineGetRPM () |
Returns engine's rpm value. | |
proto native bool | EngineIsOn () |
Returns true when engine is running, false otherwise. | |
proto native void | EngineStart () |
Starts the engine. | |
proto native void | EngineStop () |
Stops the engine. | |
proto native vector | PropellerGetPosition () |
Returns the propeller position in local space. | |
proto native float | PropellerGetAngularVelocity () |
Returns the angular velocity of the propeller. | |
proto native float | GetFluidCapacity (BoatFluid fluid) |
proto native float | GetFluidFraction (BoatFluid fluid) |
proto native void | Leak (BoatFluid 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 | Fill (BoatFluid fluid, float amount) |
Adds to the specified fluid the specified amount. | |
void | OnInput (float dt) |
bool | OnBeforeEngineStart () |
void | OnEngineStart () |
void | OnEngineStop () |
void | OnGearChanged (int newGear, int oldGear) |
void | OnFluidChanged (BoatFluid fluid, float newValue, float oldValue) |
float | OnSound (BoatSoundCtrl ctrl, float oldValue) |
proto native CarController | GetController () |
DEPRECATED, left for backwards compatibility, the methods of this class are now directly accessible on Car itself. | |
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. | |
override bool | IsAreaAtDoorFree (int currentSeat, float maxAllowedObjHeight=0.5, float horizontalExtents=0.5, float playerHeight=1.7) |
override Shape | DebugFreeAreaAtDoor (int currentSeat, float maxAllowedObjHeight=0.5, float horizontalExtents=0.5, float playerHeight=1.7) |
protected bool | DetectFlippedUsingWheels (VehicleFlippedContext ctx, bool disallowSide) |
proto native float | GetSteering () |
Returns the current steering value in range <-1, 1>. | |
proto native void | SetSteering (float in, bool analog=false) |
proto native float | GetThrustTurbo () |
Returns the current thrust turbo modifier value in range <0, 1>. | |
proto native float | GetThrustGentle () |
Returns the current thrust gentle modifier value in range <0, 1>. | |
proto native float | GetThrust () |
Returns the current thrust value in range <0, 1>. | |
proto native void | SetThrust (float in, float gentle=0, float turbo=0) |
proto native float | GetBrake () |
Returns the current brake value in range <0, 1>. | |
proto native void | SetBrake (float in, float panic=0, bool gentle=false) |
proto native float | GetHandbrake () |
Returns the current handbrake value in range <0, 1>. | |
proto native void | SetHandbrake (float in) |
proto native void | SetBrakesActivateWithoutDriver (bool activate=true) |
proto native float | GetClutch () |
Returns the current clutch value in range <0, 1>. | |
proto native void | SetClutchState (bool in) |
proto native int | GetGear () |
Returns index of the current gear. | |
proto native void | ShiftUp () |
proto native void | ShiftTo (CarGear gear) |
proto native void | ShiftDown () |
proto native float | GetFluidCapacity (CarFluid fluid) |
proto native float | GetFluidFraction (CarFluid fluid) |
proto native void | Leak (CarFluid fluid, float amount) |
Removes from the specified fluid the specified amount. | |
proto native void | LeakAll (CarFluid fluid) |
Removes all the specified fluid from vehicle. | |
proto native void | Fill (CarFluid fluid, float amount) |
Adds to the specified fluid the specified amount. | |
void | OnFluidChanged (CarFluid fluid, float newValue, float oldValue) |
proto native float | EngineGetRPMMin () |
Returns engine's min operating rpm. | |
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 | EngineGetRPMRedline () |
Returns engine's maximal working rpm without damaging the engine. | |
proto native float | EngineGetRPM () |
Returns engine's rpm value. | |
proto native bool | EngineIsOn () |
Returns true when engine is running, false otherwise. | |
proto native void | EngineStart () |
Starts the engine. | |
bool | OnBeforeEngineStart () |
void | OnEngineStart () |
Is called every time the engine starts. | |
proto native void | EngineStop () |
Stops the engine. | |
void | OnEngineStop () |
Is called every time the engine stops. | |
proto native vector | GetEnginePos () |
Get actual position of engine (model space) | |
proto native void | SetEnginePos (vector pos) |
Override the position of engine (model space) | |
proto native int | GetGearsCount () |
Returns total number of gears. | |
proto native CarGearboxType | GearboxGetType () |
Returns gearbox type. See CarGearboxType enum for more info. | |
proto native CarAutomaticGearboxMode | GearboxGetMode () |
Returns gearbox mode. This is useful when car has automatic gearbox. | |
void | OnGearChanged (int newGear, int oldGear) |
proto native bool | WheelIsAnyLocked () |
Returns true if any of the wheels are locked in terms of its movement. | |
proto native float | WheelGetAngularVelocity (int wheelIdx) |
proto native bool | WheelHasContact (int wheelIdx) |
proto native vector | WheelGetContactPosition (int wheelIdx) |
proto native vector | WheelGetContactNormal (int wheelIdx) |
proto native vector | WheelGetDirection (int wheelIdx) |
proto native SurfaceInfo | WheelGetSurface (int wheelIdx) |
proto native CarWheelWaterState | WheelGetWaterState (int wheelIdx) |
proto native EntityAI | WheelGetEntity (int wheelIdx) |
proto native bool | WheelIsLocked (int wheelIdx) |
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) | |
void | OnContact (string zoneName, vector localPos, IEntity other, Contact data) |
float | OnSound (CarSoundCtrl ctrl, float oldValue) |
void | OnInput (float dt) |
void | OnUpdate (float dt) |
proto native void | ForcePosition (vector pos) |
proto native void | ForceDirection (vector dir) |
Base native class for all motorized wheeled vehicles.
Base native class for helicopter.
|
inlineprivate |
References ARGB(), Debug::DrawBox(), GetSpeedometerAbsolute(), IsAreaAtDoorFree(), and Shape.
|
inlineprivate |
References vector::Dot(), vector::Up, WheelCount(), and WheelHasContact().
|
private |
Returns engine's rpm value.
|
private |
Returns engine's rpm value.
|
private |
Returns engine's idle rpm before engine stalls.
|
private |
Returns engine's idle rpm before engine stalls.
|
private |
Returns engine's max rpm before engine blows up.
|
private |
Returns engine's max rpm before engine blows up.
|
private |
Returns engine's min operating rpm.
|
private |
Returns engine's min operating rpm.
|
private |
Returns engine's maximal working rpm without damaging the engine.
|
private |
Returns engine's maximal working rpm without damaging the engine.
|
private |
Returns true when engine is running, false otherwise.
|
private |
Returns true when engine is running, false otherwise.
|
private |
Starts the engine.
Referenced by OnFinishProgress().
|
private |
Starts the engine.
|
private |
Stops the engine.
|
private |
Stops the engine.
Adds to the specified fluid the specified amount.
Adds to the specified fluid the specified amount.
|
private |
|
private |
|
private |
Returns gearbox mode. This is useful when car has automatic gearbox.
|
private |
Returns gearbox type. See CarGearboxType enum for more info.
|
private |
Returns the current brake value in range <0, 1>.
|
private |
Returns the value of how much the clutch is disengaged.
|
private |
Returns the current clutch value in range <0, 1>.
|
private |
DEPRECATED, left for backwards compatibility, the methods of this class are now directly accessible on Car itself.
|
private |
Returns the index of the current gear, -1 if there is no engine.
|
private |
Get actual position of engine (model space)
Returns tank capacity for the specified vehicle's fluid.
fluid | the specified fluid type |
Returns tank capacity for the specified vehicle's fluid.
fluid | the specified fluid type |
Returns fraction value (in range <0, 1>) of the current state of the specified vehicle's fluid.
[in] | fluid | the specified fluid type |
Returns fraction value (in range <0, 1>) of the current state of the specified vehicle's fluid.
[in] | fluid | the specified fluid type |
|
private |
Returns the index of the future gear, -1 if there is no engine.
|
private |
Returns index of the current gear.
|
private |
Returns the number of gears.
|
private |
Returns total number of gears.
|
private |
Returns the current handbrake value in range <0, 1>.
|
inlineprivate |
|
private |
Returns the index of the neutral gear.
|
inlineprivate |
|
private |
Returns the current speed of the vehicle in km/h.
Referenced by GetSpeedometerAbsolute().
|
inlineprivate |
Returns the current speed of the vehicle in km/h. Value is absolute.
References Math::AbsFloat(), and GetSpeedometer().
Referenced by ActionStopEngine::ActionCondition(), DebugFreeAreaAtDoor(), and IsAreaAtDoorFree().
|
private |
Returns the actual steering value in range <-1, 1>.
|
private |
Returns the current steering value in range <-1, 1>.
|
private |
Returns the actual throttle value in range <0, 1>.
|
private |
Returns the current thrust value in range <0, 1>.
|
private |
Returns the current thrust gentle modifier value in range <0, 1>.
|
private |
Returns the current thrust turbo modifier value in range <0, 1>.
|
private |
Returns if there is an engine.
Removes from the specified fluid the specified amount.
Removes from the specified fluid the specified amount.
|
private |
Removes all the specified fluid from vehicle.
|
private |
Removes all the specified fluid from vehicle.
|
inlineprivate |
Is called every time the game wants to start the engine.
Referenced by OnExecute().
|
inlineprivate |
Is called every time the game wants to start the engine.
Is called every time when vehicle collides with other object.
[in] | zoneName | configured vehicle's zone that was hit |
[in] | localPos | position where the vehicle was hit in vehicle's space |
[in] | other | object with which the vehicle is colliding |
[in] | data | contact properties |
|
inlineprivate |
Is called every time the engine starts.
|
inlineprivate |
Is called every time the engine starts.
|
inlineprivate |
Is called every time the engine stops.
|
inlineprivate |
Is called every time the engine stops.
Is called every time when the specified vehicle's fluid level changes. This callback is called on owner only.
[in] | fluid | fluid identifier, |
[in] | newValue | new fluid level |
[in] | oldValue | previous fluid level before change |
Is called every time when the specified vehicle's fluid level changes eg. when vehicle is consuming fuel.
[in] | fluid | fluid identifier, |
[in] | newValue | new fluid level |
[in] | oldValue | previous fluid level before change |
Is called every time when the simulation changed gear.
[in] | newGear | new gear level |
[in] | oldGear | previous gear level before gear shift |
Is called every time when the simulation changed gear.
[in] | newGear | new gear level |
[in] | oldGear | previous gear level before gear shift |
|
inlineprivate |
Called every physics simulation step before inputs are applied.
|
inlineprivate |
Is called after every input simulation step.
Note that the player character and other systems can always change the internal state. It is highly recommended to store state of custom inputs elsewhere and call Setters here.
[in] | dt | frame time in seconds |
|
inlineprivate |
Is called every sound simulation step. In this callback, user can modify behaviour of sound controllers.
[in] | ctrl | sound controller identifier, |
[in] | oldValue | already computed value by the game code |
|
inlineprivate |
Is called every sound simulation step. In this callback, user can modify behaviour of sound controllers.
[in] | ctrl | sound controller identifier, |
[in] | oldValue | already computed value by the game code |
|
inlineprivate |
Is called every game frame.
[in] | dt | frame time in seconds |
|
private |
Returns the angular velocity of the propeller.
|
private |
Returns the propeller position in local space.
Sets the brake value.
in | should be in range <0, 1> |
panic | should be in range <0, 1> |
|
private |
Sets if brakes should activate without a driver present
|
private |
Sets the clutch state.
|
private |
Override the position of engine (model space)
|
private |
Sets the handbrake value.
in | should be in range <0, 1> |
Sets the steering value.
in | should be in range <-1, 1> |
analog | indicates if the input value was taken from analog controller |
|
private |
Sets the future steering value.
|
private |
Sets the future throttle value.
Sets the thrust value.
in | should be in range <0, 1> |
gentle | should be in range <0, 1>, thrust modifier |
turbo | should be in range <0, 1>, thrust modifier |
|
private |
Shifts the future gear down, triggering gearbox simulation.
|
private |
|
private |
|
private |
Shifts the future gear to selected gear, triggering gearbox simulation.
|
private |
Shifts the future gear up, triggering gearbox simulation.
|
private |
|
private |
How many wheel can be attached to a car (hubs only)
Referenced by DetectFlippedUsingWheels().
|
private |
Number of actually attached wheels (hubs only)
Returns the raw angular velocity of the wheel, unstable value
[in] | wheelIdx | index of the wheel, they are counted from left-front to rear-right |
Returns the normal of contact in world space, only valid if there was an actual contact
[in] | wheelIdx | index of the wheel, they are counted from left-front to rear-right |
Returns the position of contact in world space, only valid if there was an actual contact
[in] | wheelIdx | index of the wheel, they are counted from left-front to rear-right |
Returns the direction pointing forwards that the wheel is facing
[in] | wheelIdx | index of the wheel, they are counted from left-front to rear-right |
Returns the entity attached that represents the wheel
[in] | wheelIdx | index of the wheel, they are counted from left-front to rear-right |
|
private |
Returns the surface that the wheel is nearby
[in] | wheelIdx | index of the wheel, they are counted from left-front to rear-right |
|
private |
Returns the state that the wheel is in with water
[in] | wheelIdx | index of the wheel, they are counted from left-front to rear-right |
Returns true if given wheel is making any contact
[in] | wheelIdx | index of the wheel, they are counted from left-front to rear-right |
Referenced by DetectFlippedUsingWheels().
|
private |
Returns true if any of the wheels are locked in terms of its movement.
Returns true if given wheel is locked in terms of its movement.
[in] | wheelIdx | index of the wheel, they are counted from left-front to rear-right |