Difference between revisions of "GetVehicleRotation"

From Multi Theft Auto: Wiki
(Removed X Y Z variants of the function, fixed the syntax)
Line 1: Line 1:
{{Needs_Checking|Does the function really start with a capital G? [[User:Erorr404|Erorr404]]}}
 
 
 
__NOTOC__
 
__NOTOC__
 
==Description==
 
==Description==
Line 6: Line 4:
  
 
==Syntax==
 
==Syntax==
<syntaxhighlight lang="lua">float float float GetVehicleRotation ( vehicle )</syntaxhighlight>
+
<syntaxhighlight lang="lua">float float float getVehicleRotation ( vehicle )</syntaxhighlight>
 
 
This function also has three variants that allow you to retrieve data from just one of the three axes.
 
 
 
<syntaxhighlight lang="lua">float GetVehicleRotationX ( vehicle )</syntaxhighlight>
 
 
 
<syntaxhighlight lang="lua">float GetVehicleRotationY ( vehicle )</syntaxhighlight>
 
 
 
<syntaxhighlight lang="lua">float GetVehicleRotationZ ( vehicle )</syntaxhighlight>
 
  
 
===Required Arguments===
 
===Required Arguments===
Line 25: Line 15:
 
This example creates a vehicle and gets it's rotation:
 
This example creates a vehicle and gets it's rotation:
 
<syntaxhighlight lang="lua">local newcar = createVehicle ( 520, 1024, 1024, 1024 ) -- create a Hydra
 
<syntaxhighlight lang="lua">local newcar = createVehicle ( 520, 1024, 1024, 1024 ) -- create a Hydra
local rx, ry, rz = GetVehicleRotation ( newcar ) -- get the vehicle's x, y, and z rotations and store them in rx, ry, and rz
+
local rx, ry, rz = getVehicleRotation ( newcar ) -- get the vehicle's x, y, and z rotations and store them in rx, ry, and rz
 
outputChatBox ( "Current rotation: " .. x .. " " .. y .. " " .. z ) -- output the rotations
 
outputChatBox ( "Current rotation: " .. x .. " " .. y .. " " .. z ) -- output the rotations
 
</syntaxhighlight>
 
</syntaxhighlight>

Revision as of 20:56, 1 November 2006

Description

This function gets the rotation of a vehicle along the X, Y, and Z axes in degrees.

Syntax

float float float getVehicleRotation ( vehicle )

Required Arguments

  • vehicle: The vehicle whose rotation you want to retrieve.

Returns

Returns three floats indicating the X, Y, and Z rotations of the vehicle in degrees (one float for a variant function), or false if the specified vehicle does not exist.

Example

This example creates a vehicle and gets it's rotation:

local newcar = createVehicle ( 520, 1024, 1024, 1024 ) -- create a Hydra
local rx, ry, rz = getVehicleRotation ( newcar ) -- get the vehicle's x, y, and z rotations and store them in rx, ry, and rz
outputChatBox ( "Current rotation: " .. x .. " " .. y .. " " .. z ) -- output the rotations

See Also