CreateVehicle: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
m (→‎Syntax: OOP)
mNo edit summary
 
(29 intermediate revisions by 18 users not shown)
Line 1: Line 1:
{{Needs_Checking|
* Explain the direction parameter which should always be false and what is the point of having a parameter whose value need to be the same all the time. --[[User:MTA SE|MTA SE]] 20:05, 5 July 2012 (UTC)
}}
__NOTOC__
__NOTOC__
{{Server client function}}
{{Server client function}}{{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_box|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.}}
This function creates a vehicle at the specified location.
This function creates a vehicle at the specified location.


Its worth noting that the position of the vehicle is the center point of the vehicle, not its base. As such, you need to ensure that the z value (vertical axis) is some height above the ground. You can find the exact height using the client side function [[getElementDistanceFromCentreOfMassToBaseOfModel]], or you can estimate it yourself and just spawn the vehicle so it drops to the ground.
Its worth nothing that the position of the vehicle is the center point of the vehicle, not its base. As such, you need to ensure that the z value (vertical axis) is some height above the ground. You can find the exact height using the client side function [[getElementDistanceFromCentreOfMassToBaseOfModel]], or you can estimate it yourself and just spawn the vehicle so it drops to the ground.
 


==Syntax==
==Syntax==
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
vehicle createVehicle ( int model, float x, float y, float z [, float rx, float ry, float rz, string numberplate, bool bDirection, int variant1, int variant2 ] )
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 ] )
</syntaxhighlight>
</syntaxhighlight>
{{OOP|This function is also a static function underneath the Vehicle class.|[[vehicle]]:create||}}
{{OOP||[[Vehicle]]||}}


===Required Arguments===
===Required Arguments===
Line 27: Line 23:
* '''ry''': A floating point number representing the rotation about the Y 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.
* '''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 car (max 8 characters). This is only applicable to cars.
* '''numberplate''': A string that will go on the number plate of the vehicle (max 8 characters).
* '''direction''': A boolean which should be set to false. *SERVER ONLY*
* '''bDirection''' ''(serverside only)'': 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.
{{New feature/item|3.0120|1.2||  
{{New feature/item|3.0120|1.2||  
* '''variant1''': An integer for the first vehicle variant see [[Vehicle variants]]
* '''variant1''': An integer for the first vehicle variant. See [[vehicle variants]].
* '''variant2''': An integer for the second vehicle variant see [[Vehicle variants]]
* '''variant2''': An integer for the second vehicle variant. See [[vehicle variants]].
}}
{{New feature/item|3.0161|1.6.0|22477|
* '''synced''' ''(serverside only)'': A boolean value representing whether or not the vehicle will be synced. Disabling the sync might be useful for frozen or static vehicles to increase the server performance.
}}
}}


Line 38: Line 37:


==Using trains==
==Using trains==
Trains are created using the createVehicle function. They are placed at the nearest point of the GTASA train pathing (railroad tracks) from their spawning point.  
Trains are created using the createVehicle function. They are placed at the nearest point of the GTASA train pathing (they usually are railroad tracks) from their spawning point.


==Example==
==Example==
<section name="Example 1: Server" class="server" show="true">
<section name="Example 1: Server" class="server" show="true">
This script spawns a Rhino on top of one lucky individual.
This example creates a 'vehicle spawner' marker that gives the player a vehicle as soon they step into it.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
function scriptCreateTank ( player, command )
local vehMark = createMarker(-2426.34106, -639.12714, 132.93631,"cylinder")
      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 )
</syntaxhighlight>
</section>


<section name="Example 2: Client" class="client" show="true">
function vehicleSpawner(hitElement,matchingDimension)
This script spawns a Rhino on top of the local player.
if getElementType(hitElement) == "player" then
<syntaxhighlight lang="lua">
if getPedOccupiedVehicle(hitElement) == false then
function scriptCreateTank ( commandName )
local x,y,z = getElementPosition(hitElement)
      local luckyBugger = getLocalPlayer() -- get the local player
local veh = createVehicle(551, x,y,z)
      local x, y, z = getElementPosition ( luckyBugger ) -- retrive the player's position
warpPedIntoVehicle(hitElement,veh)
      createVehicle ( 432, x, y, z + 10 ) -- create the tank 10 units above them
end
      outputChatBox ( "You got Tank'd!", 255, 0, 0)
end  
end
end
--Attach the 'scriptCreateTank' function to the "tank" command
addEventHandler("onMarkerHit",vehMark,vehicleSpawner)
addCommandHandler ( "tank", scriptCreateTank )
</syntaxhighlight>
</syntaxhighlight>
</section>
</section>


<section name="Example 3: Server" class="server" show="false">
<section name="Example 2: Server" class="server" show="true">
This example creates a vehicle five units to the right of a player when they type ''createvehicle'' and its name in the console:
This example creates a vehicle five units to the right of a player when they type ''createvehicle'' and its name in the console:
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
Line 80: Line 70:
       -- calculate the position of the vehicle based on the player's position and rotation:
       -- 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 x, y, z = getElementPosition ( sourcePlayer ) -- get the player's position
       local rotZ = getPedRotation ( sourcePlayer ) -- get the player's rotation around the Z axis in degrees
       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
       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
       y = y + ( ( math.sin ( math.rad ( rotZ ) ) ) * distance ) -- calculate the Y position of the vehicle
Line 102: Line 92:
-- Attach the 'consoleCreateVehicle' function to the "createvehicle" command
-- Attach the 'consoleCreateVehicle' function to the "createvehicle" command
addCommandHandler ( "createvehicle", consoleCreateVehicle )
addCommandHandler ( "createvehicle", consoleCreateVehicle )
</syntaxhighlight>
</section>
<section name="Example 3: Server" class="server" show="false">
This script spawns a Rhino on top of one lucky individual.
<syntaxhighlight lang="lua">
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 )
</syntaxhighlight>
</section>
<section name="Example 4: Server" class="server" show="false">
This example adds a ''/spveh'' command 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.
<syntaxhighlight lang="lua">
-- 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
)
</syntaxhighlight>
</section>
<section name="Example 5: Client" class="client" show="true">
This script spawns a Rhino on top of the local player.
<syntaxhighlight lang="lua">
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 )
</syntaxhighlight>
</syntaxhighlight>
</section>
</section>




{{New items|4.0132|1.4|
{{New items|3.0132|1.4|
This is an example of how this function is executed in an OOP environment.
This is an example of how this function is executed in an OOP environment.
<section name="OOP server" class="server" show="true">
<section name="OOP server" class="server" show="true">
Line 130: Line 186:
</section>
</section>
}}
}}
==See Also==
==See Also==




{{Vehicle functions}}
{{Vehicle functions}}
[[de:createVehicle]]
[[pl:createVehicle]]
[[ru:CreateVehicle]]
[[pt-br:CreateVehicle]]

Latest revision as of 09:51, 16 July 2024

[[{{{image}}}|link=|]] 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.
[[{{{image}}}|link=|]] 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.

This function creates a vehicle at the specified location.

Its worth nothing that the position of the vehicle is the center point of the vehicle, not its base. As such, you need to ensure that the z value (vertical axis) is some height above the ground. You can find the exact height using the client side function getElementDistanceFromCentreOfMassToBaseOfModel, or you can estimate it yourself and just spawn the vehicle so it drops to the ground.

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 ] )

OOP Syntax Help! I don't understand this!

Method: Vehicle(...)


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.

Optional Arguments

NOTE: When using optional arguments, you might need to supply all arguments before the one you wish to use. For more information on optional arguments, see optional arguments.

  • 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 (serverside only): 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.
ADDED/UPDATED IN VERSION 1.6.0 r22477:
  • synced (serverside only): A boolean value representing whether or not the vehicle will be synced. Disabling the sync might be useful for frozen or static vehicles to increase the server performance.

Returns

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

Using trains

Trains are created using the createVehicle function. They are placed at the nearest point of the GTASA train pathing (they usually are railroad tracks) from their spawning point.

Example

Click to collapse [-]
Example 1: Server

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)
Click to collapse [-]
Example 2: Server

This example creates a vehicle five units to the right of a player when they type createvehicle and 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 )
Click to expand [+]
Example 3: Server
Click to expand [+]
Example 4: Server
Click to collapse [-]
Example 5: Client

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 )


This is an example of how this function is executed in an OOP environment.

Click to collapse [-]
OOP server

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