Manual Review Required

Please finish this page using the corresponding Old Wiki article. Go to Contribution guidelines for more information.

---

This function is used to change the handling data of a vehicle.

Note

For functionality reasons, suspension modification is disabled on monster trucks, trains, boats and trailers. Additionally, helicopters are not affected by custom handling. The vehicle-on-wheels handling does not affect planes when they are on the ground either. For more information on this, see issue 2426

Caution

To change handling values of aircraft like maxVelocity , you must first set setAircraftMaxVelocity .

Syntax

bool setVehicleHandling ( element theVehicle, string property, var value )

Required Arguments

• theVehicle: The vehicle you wish to set the handling of.
• property: The property you wish to set the handling of the vehicle to.
• value: MISSING_PARAM_DESC

Returns

• bool: value

Returns true if the handling was set successfully, false otherwise. See below a list of valid properties and their required values:

Code Examples

Example 1 Example 2 Example 3

shared

function vhandling ( theVehicle )
    if getElementModel(theVehicle) == 411 then -------------- vehicle Id
        setVehicleHandling(theVehicle, "mass", 300.0)
        setVehicleHandling(theVehicle, "turnMass", 200)
        setVehicleHandling(theVehicle, "dragCoeff", 4.0 )
        setVehicleHandling(theVehicle, "centerOfMass", { 0.0,0.08,-0.09 } )
        setVehicleHandling(theVehicle, "percentSubmerged", 103)
        setVehicleHandling(theVehicle, "tractionMultiplier", 1.8)
        setVehicleHandling(theVehicle, "tractionLoss", 1.0)
        setVehicleHandling(theVehicle, "tractionBias", 0.48)
        setVehicleHandling(theVehicle, "numberOfGears", 5)
        setVehicleHandling(theVehicle, "maxVelocity", 300.0)
        setVehicleHandling(theVehicle, "engineAcceleration", 90.0 )
        setVehicleHandling(theVehicle, "engineInertia", 5.0)
        setVehicleHandling(theVehicle, "driveType", "rwd")
        setVehicleHandling(theVehicle, "engineType", "petrol")
        setVehicleHandling(theVehicle, "brakeDeceleration", 20.0)
        setVehicleHandling(theVehicle, "brakeBias", 0.60)
        -----abs----
        setVehicleHandling(theVehicle, "steeringLock",  35.0 )
        setVehicleHandling(theVehicle, "suspensionForceLevel", 0.85)
        setVehicleHandling(theVehicle, "suspensionDamping", 0.15 )
        setVehicleHandling(theVehicle, "suspensionHighSpeedDamping", 0.0)
        setVehicleHandling(theVehicle, "suspensionUpperLimit", 0.15 )
        setVehicleHandling(theVehicle, "suspensionLowerLimit", -0.16)
        setVehicleHandling(theVehicle, "suspensionFrontRearBias", 0.5 )
        setVehicleHandling(theVehicle, "suspensionAntiDiveMultiplier", 0.0)
        setVehicleHandling(theVehicle, "seatOffsetDistance", 0.0)
        setVehicleHandling(theVehicle, "collisionDamageMultiplier", 0.00)
        --setVehicleHandling(theVehicle, "monetary",  10000) This one is disabled for now
        setVehicleHandling(theVehicle, "modelFlags", 1002000)
        setVehicleHandling(theVehicle, "handlingFlags", 1000002)
        --setVehicleHandling(theVehicle, "headLight", 3) This one is disabled for now
        --setVehicleHandling(theVehicle, "tailLight", 2) This one is disabled for now
        --setVehicleHandling(theVehicle, "animGroup", 4) This one is disabled for now
    end
end
addEventHandler ( "onPlayerVehicleEnter", getRootElement(), vhandling )

shared

function massChange ( me, command, mass )
    local mass = tonumber ( mass ) -- Convert mass to a number
    local veh = getPedOccupiedVehicle ( me ) -- Get the player's vehicle

    if mass and veh then  -- If valid mass and in a vehicle
        local success = setVehicleHandling ( veh, "mass", mass) -- Set the vehicle's mass, and check if successful

        if success then -- If successful
            outputChatBox ( "Your vehicle's mass has been changed to: "..mass.." kg", me, 0, 255, 0 ) -- Notify the player of success
        else -- Too bad failure is still an option
            outputChatBox ( "Setting mass failed. It's probably above or below allowed limits", me, 255, 0, 0 ) -- Notify the player of failure, and give a possible reason
        end
    elseif not veh then -- If not in a vehicle
        outputChatBox ( "You're not in a vehicle", me, 255, 0, 0 ) -- Tell the player; He / she obviously doesn't know
    elseif not mass then -- If not a valid mass
        outputChatBox ( "Syntax: /changemass [mass]", me, 255, 0, 0 ) -- Tell the player the proper syntax
    end
end
addCommandHandler ( "changemass", massChange )

shared

local predefinedHandling = {
  [411] = {
    ["engineAcceleration"] = 14,
    ["dragCoeff"] = 0,
    ["maxVelocity"] = 100000,
    ["tractionMultiplier"] = 0.9,
    ["tractionLoss"] = 1.1,
  },
  [415] = {
    ["engineAcceleration"] = 14,
    ["dragCoeff"] = 0,
    ["maxVelocity"] = 100000,
    ["tractionMultiplier"] = 0.9,
    ["tractionLoss"] = 1.1,
  },
    [562] = { -- Universal drift handling
    ["driveType"] = "rwd",
    ["engineAcceleration"] = 200,
    ["dragCoeff"] = 1.5,
    ["maxVelocity"] = 300,
    ["tractionMultiplier"] = 0.7,
    ["tractionLoss"] = 0.8,
    ["collisionDamageMultiplier"] = 0.4,
    ["engineInertia"] = -175,
    ["steeringLock"] = 75,
    ["numberOfGears"] = 4,
    ["suspensionForceLevel"] = 0.8,
    ["suspensionDamping"] = 0.8,
    ["suspensionUpperLimit"] = 0.33,
    ["suspensionFrontRearBias"] = 0.3,
    ["mass"] = 1800,
    ["turnMass"] = 3000,
    ["centerOfMass"] = { [1]=0, [2]=-0.2, [3]=-0.5 }, -- Good example to understand centerOfMass parameter usage
  },

  --next model below etc (copy rows)
}

for i,v in pairs (predefinedHandling) do
  if i then
    for handling, value in pairs (v) do
      if not setModelHandling (i, handling, value) then
        outputDebugString ("* Predefined handling '"..tostring(handling).."' for vehicle model '"..tostring(i).."' could not be set to '"..tostring(value).."'")
      end
    end
  end
end

for _,v in ipairs (getElementsByType("vehicle")) do
  if v and predefinedHandling[getElementModel(v)] then
    for k,vl in pairs (predefinedHandling[getElementModel(v)]) do
      setVehicleHandling (v, k, vl)
    end
  end
end

function resetHandling()
  for model in pairs (predefinedHandling) do
    if model then
      for k in pairs(getOriginalHandling(model)) do
        setModelHandling(model, k, nil)
      end
    end
  end

  for _,v in ipairs (getElementsByType("vehicle")) do
    if v then
      local model = getElementModel(v)
      if predefinedHandling[model] then
        for k,h in pairs(getOriginalHandling(model)) do
          setVehicleHandling(v, k, h)
        end
      end
    end
  end
end
addEventHandler("onResourceStop", resourceRoot, resetHandling)

See Also

Vehicle Functions

• addVehicleSirens
• addVehicleUpgrade
• areVehicleLightsOn
• attachTrailerToVehicle
• blowVehicle
• createVehicle
• detachTrailerFromVehicle
• fixVehicle
• getHeliBladeCollisionsEnabled
• getModelHandling
• getOriginalHandling
• getTrainDirection
• getTrainPosition
• getTrainSpeed
• getVehicleAdjustableProperty
• getVehicleColor
• getVehicleCompatibleUpgrades
• getVehicleComponentPosition
• getVehicleComponentRotation
• getVehicleComponents
• getVehicleComponentScale
• getVehicleComponentVisible
• getVehicleController
• getVehicleCurrentGear
• getVehicleDoorOpenRatio
• getVehicleDoorState
• getVehicleDummyPosition
• getVehicleEngineState
• getVehicleEntryPoints
• getVehicleGravity
• getVehicleHandling
• getVehicleHeadLightColor
• getVehicleIdleRespawnDelay
• getVehicleLandingGearDown
• getVehicleLightState
• getVehicleMaxPassengers
• getVehicleModelDummyDefaultPosition
• getVehicleModelDummyPosition
• getVehicleModelExhaustFumesPosition
• getVehicleModelFromName
• getVehicleModelWheelSize
• getVehicleName
• getVehicleNameFromModel
• getVehicleNitroCount
• getVehicleNitroLevel
• getVehicleOccupant
• getVehicleOccupants
• getVehicleOverrideLights
• getVehiclePaintjob
• getVehiclePanelState
• getVehiclePlateText
• getVehicleRespawnDelay
• getVehicleRespawnPosition
• getVehicleRespawnRotation
• getVehicleRotorSpeed
• getVehicleRotorState
• getVehicleSirenParams
• getVehicleSirens
• getVehicleSirensOn
• getVehiclesOfType
• getVehicleTowedByVehicle
• getVehicleTowingVehicle
• getVehicleTurretPosition
• getVehicleType
• getVehicleUpgradeOnSlot
• getVehicleUpgrades
• getVehicleUpgradeSlotName
• getVehicleVariant
• getVehicleWheelFrictionState
• getVehicleWheelScale
• getVehicleWheelStates
• isTrainChainEngine
• isTrainDerailable
• isTrainDerailed
• isVehicleBlown
• isVehicleDamageProof
• isVehicleFuelTankExplodable
• isVehicleLocked
• isVehicleNitroActivated
• isVehicleNitroRecharging
• isVehicleOnGround
• isVehicleRespawnable
• isVehicleSmokeTrailEnabled
• isVehicleTaxiLightOn
• isVehicleWheelOnGround
• isVehicleWindowOpen
• removeVehicleSirens
• removeVehicleUpgrade
• resetVehicleComponentPosition
• resetVehicleComponentRotation
• resetVehicleComponentScale
• resetVehicleDummyPositions
• resetVehicleExplosionTime
• resetVehicleIdleTime
• respawnVehicle
• setHeliBladeCollisionsEnabled
• setModelHandling
• setTrainDerailable
• setTrainDerailed
• setTrainDirection
• setTrainPosition
• setTrainSpeed
• setVehicleAdjustableProperty
• setVehicleColor
• setVehicleComponentPosition
• setVehicleComponentRotation
• setVehicleComponentScale
• setVehicleComponentVisible
• setVehicleDamageProof
• setVehicleDoorOpenRatio
• setVehicleDoorState
• setVehicleDoorsUndamageable
• setVehicleDummyPosition
• setVehicleEngineState
• setVehicleFuelTankExplodable
• setVehicleGravity
• setVehicleHandling
• setVehicleHeadLightColor
• setVehicleIdleRespawnDelay
• setVehicleLandingGearDown
• setVehicleLightState
• setVehicleLocked
• setVehicleModelDummyPosition
• setVehicleModelExhaustFumesPosition
• setVehicleModelWheelSize
• setVehicleNitroActivated
• setVehicleNitroCount
• setVehicleNitroLevel
• setVehicleOverrideLights
• setVehiclePaintjob
• setVehiclePanelState
• setVehiclePlateText
• setVehicleRespawnDelay
• setVehicleRespawnPosition
• setVehicleRespawnRotation
• setVehicleRotorSpeed
• setVehicleRotorState
• setVehicleSirens
• setVehicleSirensOn
• setVehicleSmokeTrailEnabled
• setVehicleTaxiLightOn
• setVehicleTurretPosition
• setVehicleVariant
• setVehicleWheelScale
• setVehicleWheelsRotation
• setVehicleWheelStates
• setVehicleWindowOpen
• spawnVehicle
• spawnVehicleFlyingComponent
• toggleVehicleRespawn

Vehicle Events

• onClientTrailerAttach
• onClientTrailerDetach
• onClientVehicleCollision
• onClientVehicleDamage
• onClientVehicleEnter
• onClientVehicleExit
• onClientVehicleExplode
• onClientVehicleNitroStateChange
• onClientVehicleRespawn
• onClientVehicleStartEnter
• onClientVehicleStartExit
• onClientVehicleWeaponHit
• onTrailerAttach
• onTrailerDetach
• onVehicleDamage
• onVehicleEnter
• onVehicleExit
• onVehicleExplode
• onVehicleRespawn
• onVehicleStartEnter
• onVehicleStartExit

Reference

• Scripting Functions