Needs checking

This function was partially migrated from the old wiki. Please review manually:

• Missing section: Using trains

Manual Review Required

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

---

This function creates a vehicle at the specified location.

Note

Vehicles (and other elements) created client-side are only seen by the client that created them, aren't synced and players cannot enter them. They are essentially for display only.

Note

Due to how GTA works, creating a lot of vehicles in the same place will cause lag. The more geometries and unique textures has model the bigger the lag is. Even a lot of default vehicles will cause lag if in the same place.

OOP Syntax Help! I don't understand this!

• Constructor: Vehicle (...)

Syntax

vehicle createVehicle ( int model, float x, float y, float z, float rx, float ry, float rz, string numberplate, bool bDirection, int variant1, int variant2, [ bool synced = true ] )

Required Arguments

• model: The vehicle ID of the vehicle being created.
• x: A floating point number representing the X coordinate on the map.
• y: A floating point number representing the Y coordinate on the map.
• z: A floating point number representing the Z coordinate on the map.
• rx: A floating point number representing the rotation about the X axis in degrees.
• ry: A floating point number representing the rotation about the Y axis in degrees.
• rz: A floating point number representing the rotation about the Z axis in degrees.
• numberplate: A string that will go on the number plate of the vehicle (max 8 characters).
• bDirection: Placeholder boolean which provides backward compatibility with some scripts. It never had any effect, but it is read by the code. It is recommended to ignore this argument, passing false or the variant1 argument in its place.
• variant1: MISSING_PARAM_DESC
• variant2: MISSING_PARAM_DESC

Optional Arguments

NOTE: When using optional arguments, you might need to supply all arguments before the one you wish to use.

• synced (default: true): MISSING_PARAM_DESC

Returns

• vehicle: value

Returns the vehicle element that was created. Returns false if the arguments are incorrect, or if the vehicle limit of 65535 is exceeded.

Code Examples

Example 1 Example 2 Example 3 Example 4 Example 5 Example 6

shared

This example creates a 'vehicle spawner' marker that gives the player a vehicle as soon they step into it.

local vehMark = createMarker(-2426.34106, -639.12714, 132.93631,"cylinder")

function vehicleSpawner(hitElement,matchingDimension)
  if getElementType(hitElement) == "player" then
    if getPedOccupiedVehicle(hitElement) == false then
    local x,y,z = getElementPosition(hitElement)
      local veh = createVehicle(551, x,y,z)
      warpPedIntoVehicle(hitElement,veh)
    end
  end
end
addEventHandler("onMarkerHit",vehMark,vehicleSpawner)

shared

This example creates a vehicle five units to the right of a player when they typecreatevehicleand its name in the console:

local distance = 5 --units

-- define our handler (we'll take a variable number of parameters where the name goes, because there are vehicle names with more than one word)
function consoleCreateVehicle ( sourcePlayer, commandName, ... )
   -- if a player triggered it, not the admin,
   if ( sourcePlayer ) then
      -- calculate the position of the vehicle based on the player's position and rotation:
      local x, y, z = getElementPosition ( sourcePlayer ) -- get the player's position
      local rotZ = getElementRotation ( sourcePlayer ) -- get the player's rotation around the Z axis in degrees
      x = x + ( ( math.cos ( math.rad ( rotZ ) ) ) * distance ) -- calculate the X position of the vehicle
      y = y + ( ( math.sin ( math.rad ( rotZ ) ) ) * distance ) -- calculate the Y position of the vehicle

      -- get the complete vehicle name by joining all passed parameters using Lua function table.concat
      local vehicleName = table.concat({...}, " ")
      -- get the vehicle's model ID from the name
      local vehicleID = getVehicleModelFromName ( vehicleName )
      -- if vehicle ID is valid,
      if vehicleID then
            -- create the vehicle using the information gathered above:
            local newVehicle = createVehicle ( vehicleID, x, y, z, 0, 0, rotZ )
            -- if vehicle creation failed, give the player a message
            if not newVehicle then
               outputConsole ( "Failed to create vehicle.", sourcePlayer )
            end
      end
   end
end

-- Attach the 'consoleCreateVehicle' function to the "createvehicle" command
addCommandHandler ( "createvehicle", consoleCreateVehicle )

shared

This script spawns a Rhino on top of one lucky individual.

function scriptCreateTank ( player, command )
      local luckyBugger = getRandomPlayer() -- get a random player
      local x, y, z = getElementPosition ( luckyBugger ) -- retrive the player's position
      createVehicle ( 432, x, y, z + 10 ) -- create the tank 10 units above them
      outputChatBox ( "You got Tank'd!", luckyBugger )
end
--Attach the 'scriptCreateTank' function to the "tank" command
addCommandHandler ( "tank", scriptCreateTank )

shared

This example adds a/spvehcommand to spawn a car model in the provided coordinates. If any car created by this command gets blown up, it will respawn where it was created.

-- Do not allow the following IDs to be spawned
local forbiddenCars = { [435] = true, [441] = true, [449] = true, [450] = true, [464] = true, [465] = true, [501] = true,
                        [537] = true, [538] = true, [564] = true, [569] = true, [570] = true, [584] = true, [590] = true,
                        [591] = true, [594] = true, [606] = true, [607] = true, [608] = true, [610] = true, [611] = true }

local cmdVehRoot = createElement("commandVehicles") -- Dummy element containing the cars that this command has created
addCommandHandler("spveh",
    function(player, cmd, modelID, x, y, z, platetext)
        -- Check whether arguments are correct
        local modelID, x, y, z = tonumber(modelID), tonumber(x), tonumber(y), tonumber(z)
        if modelID and x and y and z then
            -- Do not continue if we shouldn't
            if forbiddenCars[modelID] then
                outputChatBox("The car model you provided is not allowed.", player, 255, 0, 0)
                return
            end
            local platetext = type(platetext) == "string" and platetext or "PRIVATE"
            -- Create the actual vehicle and set it as a children of our dummy element
            setElementParent(createVehicle(modelID, x, y, z, 0, 0, 0, platetext), cmdVehRoot)
            -- Inform the player about what we did
            outputChatBox("You have created a " .. getVehicleNameFromModel(modelID) .. " (model ID: " .. modelID .. ") at " .. table.concat({ x, y, z }, ", ") .. " with numberplate " .. platetext .. " successfully.", player, 0, 255, 0)
        else
            outputChatBox("Syntax: /" .. cmd .. " (modelID) (x) (y) (z) [numberplate]", player, 255, 255, 255)
        end
    end
)

-- If a vehicle that has been created using the command blows up, respawn it where it was created
addEventHandler("onVehicleExplode", cmdVehRoot,
    function()
        respawnVehicle(source)
    end
)

shared

This script spawns a Rhino on top of the local player.

function scriptCreateTank ( commandName )
      local x, y, z = getElementPosition ( localPlayer ) -- retrive the player's position
      createVehicle ( 432, x, y, z + 10 ) -- create the tank 10 units above them
      outputChatBox ( "You got Tank'd!", 255, 0, 0)
end
--Attach the 'scriptCreateTank' function to the "tank" command
addCommandHandler ( "tank", scriptCreateTank )

shared

This script will create an Infernus at the center (0, 0, 3) of San Andreas upon execution.

addEventHandler( "onResourceStart", resourceRoot,
    function()
        infernus = Vehicle(411, Vector3(0, 0, 3)); -- Create an Infernus and spawn it at the middle of SA.
        infernus:setColor(0, 0, 0); -- Set its color to black.
        infernus.damageProof = true; -- Make it damage proof
    end
)

addCommandHandler( "blowinfernus",
    function(p)
        if not infernus.blown then -- Check if the Infernus is blown up or not.
            infernus:blow();
        else -- Ouch, it's blown up, let's output an error to the player.
            outputChatBox( "The Infernus has already been blown up by you.", p, 255, 0, 0, false );
        end
    end)

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