Difference between revisions of "GetVehicleRotation"

From Multi Theft Auto: Wiki
(Example)
m (tweak note)
 
(14 intermediate revisions by 11 users not shown)
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
==Description==
+
{{Server client function}}
This function returns three floats containing the rotational position of the vehicle along the X, Y, and Z axes respectively as degrees. If this function does fail, it will return 'false'.
+
{{Deprecated|getElementRotation|}}
  
==Syntax==
+
This function gets the rotation of a vehicle along the X, Y, and Z axes in degrees.
<syntaxhighlight lang="lua">GetVehicleRotation ( vehicle )</syntaxhighlight>
 
  
This function also has three variants that allow you to retrieve data from just one of the three axis.
+
{{Note|1=Rotation Z returns value in CCW (counter-clock wise). So 3 o'clock is not 90 degrees, it's actually 270 degrees and 9 o'clock is not 270 degrees, it's 90 degrees. '''To fix this use: rotZ = (360-rotZ)''' }}
  
<syntaxhighlight lang="lua">GetVehicleRotation|GetVehicleRotationX ( vehicle )</syntaxhighlight>
+
==Syntax==
 +
<syntaxhighlight lang="lua">float float float getVehicleRotation ( vehicle theVehicle )</syntaxhighlight>
  
<syntaxhighlight lang="lua">GetVehicleRotation|GetVehicleRotationY ( vehicle )</syntaxhighlight>
+
===Required Arguments===
 +
*'''theVehicle''': The [[vehicle]] whose rotation you want to retrieve.
  
<syntaxhighlight lang="lua">GetVehicleRotation|GetVehicleRotationZ ( vehicle )</syntaxhighlight>
+
===Returns===
 +
Returns three ''floats'' indicating the X, Y, and Z rotations of the vehicle in degrees, or ''false'' if the specified vehicle does not exist.
  
===Required Arguments===
+
==Example==
*'''vehicle''': The vehicle whose rotation you want to retrieve.
+
This example creates a vehicle and gets its rotation:
 +
<syntaxhighlight lang="lua">local newHydra = createVehicle ( 520, 1024, 1024, 1024 ) -- create a Hydra
 +
local rx, ry, rz = getVehicleRotation ( newHydra ) -- get the vehicle's x, y and z rotations and store them in rx, ry, and rz
 +
outputChatBox ( "Current rotation: " .. rx .. " " .. ry .. " " .. rz ) -- output the rotations
 +
</syntaxhighlight>
  
==Example==
+
==See Also==
<syntaxhighlight lang="lua">newcar = createVehicle ( 520, 1024, 1024, 1024 )
+
{{Vehicle functions}}
x, y, z = GetVehicleRotation ( newcar )
 
if (x)
 
outputChatBox ( "Current rotation: ", x, " ," ,y ," ," ,z , "." )
 
end</syntaxhighlight>
 

Latest revision as of 08:27, 7 September 2019

Emblem-important.png This function is deprecated. This means that its use is discouraged and that it might not exist in future versions.

Please use getElementRotation instead.


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


[[{{{image}}}|link=]] Note: Rotation Z returns value in CCW (counter-clock wise). So 3 o'clock is not 90 degrees, it's actually 270 degrees and 9 o'clock is not 270 degrees, it's 90 degrees. To fix this use: rotZ = (360-rotZ)

Syntax

float float float getVehicleRotation ( vehicle theVehicle )

Required Arguments

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

Returns

Returns three floats indicating the X, Y, and Z rotations of the vehicle in degrees, or false if the specified vehicle does not exist.

Example

This example creates a vehicle and gets its rotation:

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

See Also