CreateVehicle: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
m (Fixed 'bDirection' arg name in description)
Line 55: Line 55:
</section>
</section>


<section name="Example 2: Client" class="client" show="true">
<section name="Example 2: Server" class="server" show="true">
This example creates a car.
To create a car need to enter the number of the desired car and also specify the coordinates for the spawn point of this car.
<syntaxhighlight lang="lua">
-- Cars with this ID is not allowed
LockTransportIdentifiers = {
[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 ;
}
 
addCommandHandler("spveh", function(p, command, idmodel, sx, sy, sz, numberplate)
  if getElementType(p) == "player" then
 
  if ( tonumber(idmodel) ) and ( tonumber(sx) ) and ( tonumber(sy) ) and ( tonumber(sz) ) then
  if (not LockTransportIdentifiers[tonumber(idmodel)] ) then
            data = ( numberplate or "PRIVATE" )
            local spawn = createVehicle(tonumber(idmodel), tonumber(sx), tonumber(sy), tonumber(sz), 0, 0, 0, data)
            if isElement(spawn) then -- If the vehicle has been created then:
            outputChatBox("Your vehicle has been created! INFO:", p, 255, 255, 0)
            outputChatBox("ID Vehicle: "..getElementModel(spawn), p, 255, 255, 0)
            outputChatBox("Name Vehicle: "..getVehicleName(spawn), p, 255, 255, 0)
            local x, y, z = getElementPosition(spawn) -- Check the vehicle position
            outputChatBox("Vehicle Coordinates: X: "..tostring(x) .. ", Y: " .. tostring(y) .. ", Z: " .. tostring(z), p, 255, 255, 0)
            outputChatBox("Vehicle Number plate: "..getVehiclePlateText(spawn), p, 255, 255, 0)
    else
        outputChatBox("Unknown ERROR!", p, 255, 100, 100)
        end
    else
        outputChatBox("Sorry! This car model number is not allowed!", p, 255, 100, 100)
        end
    else
        outputChatBox("Error! Correct syntax Use: /spveh [model] [x] [y] [z] or more [Number Plate]", p, 255, 100, 100)
      end
  end
end)
</syntaxhighlight>
</section>
 
<section name="Example 3: Client" class="client" show="true">
This script spawns a Rhino on top of the local player.
This script spawns a Rhino on top of the local player.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
Line 69: Line 126:
</section>
</section>


<section name="Example 3: Server" class="server" show="false">
<section name="Example 4: Server" class="server" show="false">
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 130: Line 187:
</section>
</section>
}}
}}
==See Also==
==See Also==




{{Vehicle functions}}
{{Vehicle functions}}

Revision as of 05:33, 20 March 2016

Dialog-information.png This article needs checking.

Reason(s):
  • 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. --MTA SE 20:05, 5 July 2012 (UTC)

This template is no longer in use as it results in poor readability. 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.


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

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 car (max 8 characters). This is only applicable to cars.
  • bDirection: A boolean which should be set to false. *SERVER ONLY*

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 (railroad tracks) from their spawning point.

Example

Click to collapse [-]
Example 1: Server

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

This example creates a car. To create a car need to enter the number of the desired car and also specify the coordinates for the spawn point of this car.

-- Cars with this ID is not allowed
LockTransportIdentifiers = {
[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 ;
}

addCommandHandler("spveh", function(p, command, idmodel, sx, sy, sz, numberplate)
   if getElementType(p) == "player" then

   if ( tonumber(idmodel) ) and ( tonumber(sx) ) and ( tonumber(sy) ) and ( tonumber(sz) ) then
   if (not LockTransportIdentifiers[tonumber(idmodel)] ) then
            data = ( numberplate or "PRIVATE" )
            local spawn = createVehicle(tonumber(idmodel), tonumber(sx), tonumber(sy), tonumber(sz), 0, 0, 0, data)
            if isElement(spawn) then -- If the vehicle has been created then:
            outputChatBox("Your vehicle has been created! INFO:", p, 255, 255, 0)
            outputChatBox("ID Vehicle: "..getElementModel(spawn), p, 255, 255, 0)
            outputChatBox("Name Vehicle: "..getVehicleName(spawn), p, 255, 255, 0)
            local x, y, z = getElementPosition(spawn) -- Check the vehicle position
            outputChatBox("Vehicle Coordinates: X: "..tostring(x) .. ", Y: " .. tostring(y) .. ", Z: " .. tostring(z), p, 255, 255, 0)
            outputChatBox("Vehicle Number plate: "..getVehiclePlateText(spawn), p, 255, 255, 0)
     else
         outputChatBox("Unknown ERROR!", p, 255, 100, 100)
         end
     else
         outputChatBox("Sorry! This car model number is not allowed!", p, 255, 100, 100)
         end
     else
         outputChatBox("Error! Correct syntax Use: /spveh [model] [x] [y] [z] or more [Number Plate]", p, 255, 100, 100)
      end
   end
end)
Click to collapse [-]
Example 3: Client

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

function scriptCreateTank ( commandName )
      local luckyBugger = getLocalPlayer() -- get the local 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!", 255, 0, 0)
end
--Attach the 'scriptCreateTank' function to the "tank" command
addCommandHandler ( "tank", scriptCreateTank )
Click to expand [+]
Example 4: Server


ADDED/UPDATED IN VERSION 1.4 :

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