CreateVehicle: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 3: Line 3:


==Syntax==
==Syntax==
[[vehicle]] [[createVehicle]] ( int model, float x, float y, float z, [float rx, float ry, float rz] )
<syntaxhighlight lang="lua">vehicle createVehicle ( model, x, y, z, [rx, ry, rz] )</syntaxhighlight>


===Required Arguments===
===Required Arguments===
* '''model''': The [[Vehicle IDs|vehicle ID]] of the vehicle being created.
* '''model''': The Vehicle IDs|vehicle ID of the vehicle being created.
* '''x''': A floating point number representing the X coordinate on the map.
* '''x''': A floating point number representing the X coordinate on the map.
* '''y''': A floating point number representing the Y coordinate on the map.
* '''y''': A floating point number representing the Y coordinate on the map.
Line 19: Line 19:


==Example==
==Example==
function [[onPlayerChat]] ( player, chat )
<syntaxhighlight lang="lua">function onPlayerChat ( player, chat )
  if ( [[strtok]] ( chat, 1, 32 ) == "!createhydra" ) then
  if ( strtok ( chat, 1, 32 ) == "!createhydra" ) then
    x, y, z = [[getPlayerPosition]] ( player )
    x, y, z = getPlayerPosition ( player )
    [[createVehicle]] ( 520, x + 5, y, z )
    createVehicle ( 520, x + 5, y, z )
    [[playerPM]] ( player, "You got a hydra" )
    playerPM ( player, "You got a hydra" )
  end
  end
end
end</syntaxhighlight>

Revision as of 03:13, 18 May 2006

This function creates a vehicle and returns a handle to the created vehicle. If it fails, it will return false. This can happen if you exceed the upper vehicle limit at 65535 or due to an another unspecified future reason.

Syntax

vehicle createVehicle ( model, x, y, z, [rx, ry, rz] )

Required Arguments

  • model: The Vehicle IDs|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 Radians.
  • ry: A floating point number representing the rotation about the Y axis in Radians.
  • rz: A floating point number representing the rotation about the Z axis in Radians.

Template:UsingRadians

Example

function onPlayerChat ( player, chat )
  if ( strtok ( chat, 1, 32 ) == "!createhydra" ) then
    x, y, z = getPlayerPosition ( player )
    createVehicle ( 520, x + 5, y, z )
    playerPM ( player, "You got a hydra" )
  end
end