AddVehicleUpgrade

This function adds an upgrade to an existing vehicle, eg: nos, hyrdraulics. These upgrades are listed in San Andreas\data\maps\veh_mods\veh_mods.ide.

Syntax

Click to collapse [-]

Server and Client

bool addVehicleUpgrade ( vehicle theVehicle, int upgrade )

Required Arguments

• theVehicle: The element representing the vehicle you wish to add the upgrade to.
• upgrade: The id of the upgrade you wish to add. (1000 to 1193)

Returns

Returns true if the upgrade was successfully added to the vehicle, otherwise false.

Example

Click to expand [+]

Example 1

This serverside function allows the user to get an upgrade by typing a command:

-- define the handler function for our command
function consoleAddUpgrade ( thePlayer, commandName, id )
        -- make sure the player is in a vehicle
        if ( isPlayerInVehicle ( thePlayer ) ) then
            -- convert the given ID from a string to a number
            id = tonumber ( id )
            -- get the player's vehicle
            local theVehicle = getPlayerOccupiedVehicle ( thePlayer )
            -- add the requested upgrade to the vehicle
            local success = addVehicleUpgrade ( theVehicle, id )
            -- inform the player of whether the upgrade was added successfully
            if ( success ) then
                outputConsole ( getVehicleUpgradeSlotName ( id ) .. " upgrade added.", thePlayer )
            else
                outputConsole ( "Failed to add upgrade.", thePlayer )
            end
        else
            outputConsole ( "You must be in a vehicle!", thePlayer )
        end
end
-- add the function as a handler for the "addupgrade" command
addCommandHandler ( "addupgrade", consoleAddUpgrade )

Click to expand [+]

Example 2

This client-side script gives vehicles a nitro upgrade whenever they pass through a certain collision shape:

-- create a collision shape
local nitroColShape = createColSphere ( 1337, 100, 12, 2 )

-- attach the collision shape to an 'onClientColShapeHit' event
function onNitroColShapeHit ( hitElement, matchingDimension )
    if ( getElementType ( hitElement ) == "vehicle" ) then
        -- add a nitro upgrade if the element that hit the colshape is a vehicle
        addVehicleUpgrade ( hitElement, 1010 )
    end
end
addEventHandler ( "onClientColShapeHit", nitroColShape, onNitroColShapeHit )

See Also

• addVehicleSirens
• addVehicleUpgrade
• attachTrailerToVehicle
• blowVehicle
• createVehicle
• detachTrailerFromVehicle
• fixVehicle
• getModelHandling
• getOriginalHandling
• getTrainDirection
• getTrainPosition
• getTrainSpeed
• getVehicleColor
• getVehicleCompatibleUpgrades
• getVehicleController
• getVehicleDoorOpenRatio
• getVehicleDoorState
• getVehicleEngineState
• getVehicleHandling
• getVehicleHeadLightColor
• getVehicleLandingGearDown
• getVehicleLightState
• getVehicleMaxPassengers
• getVehicleModelFromName
• getVehicleName
• getVehicleNameFromModel
• getVehicleOccupant
• getVehicleOccupants
• getVehicleOverrideLights
• getVehiclePaintjob
• getVehiclePanelState
• getVehiclePlateText
• getVehicleRespawnPosition
• getVehicleRespawnRotation
• getVehicleSirenParams
• getVehicleSirens
• getVehicleSirensOn
• getVehiclesOfType
• getVehicleTowedByVehicle
• getVehicleTowingVehicle
BEFORE VERSION 1.5.6 :
getVehicleTurnVelocity
• getVehicleTurretPosition
• getVehicleType
• getVehicleUpgradeOnSlot
• getVehicleUpgrades
• getVehicleUpgradeSlotName
• getVehicleVariant
• getVehicleWheelStates
• isTrainDerailable
• isTrainDerailed
• isVehicleBlown
• isVehicleDamageProof
• isVehicleFuelTankExplodable
• isVehicleLocked
• isVehicleOnGround
• isVehicleTaxiLightOn
• removeVehicleSirens
• removeVehicleUpgrade
• resetVehicleExplosionTime
• resetVehicleIdleTime
• respawnVehicle
• setModelHandling
• setTrainDerailable
• setTrainDerailed
• setTrainDirection
• setTrainPosition
• setTrainSpeed
• setVehicleColor
• setVehicleDamageProof
• setVehicleDoorOpenRatio
• setVehicleDoorState
• setVehicleDoorsUndamageable
• setVehicleEngineState
• setVehicleFuelTankExplodable
• setVehicleHandling
• setVehicleHeadLightColor
• setVehicleIdleRespawnDelay
• setVehicleLandingGearDown
• setVehicleLightState
• setVehicleLocked
• setVehicleOverrideLights
• setVehiclePaintjob
• setVehiclePanelState
• setVehiclePlateText
• setVehicleRespawnDelay
• setVehicleRespawnPosition
• setVehicleRespawnRotation
• setVehicleSirens
• setVehicleSirensOn
• setVehicleTaxiLightOn
BEFORE VERSION 1.5.6 :
setVehicleTurnVelocity
• setVehicleTurretPosition
• setVehicleVariant
• setVehicleWheelStates
• spawnVehicle
• toggleVehicleRespawn