GetVehicleRotation: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
m (tweak note)
 
(11 intermediate revisions by 10 users not shown)
Line 1: Line 1:
{{Needs_Checking|Does the function really start with a capital G? [[User:Erorr404|Erorr404]]}}  
__NOTOC__
{{Server client function}}
{{Deprecated|getElementRotation|}}


__NOTOC__
==Description==
This function gets the rotation of a vehicle along the X, Y, and Z axes in degrees.
This function gets the rotation of a vehicle along the X, Y, and Z axes in degrees.
{{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)''' }}


==Syntax==
==Syntax==
<syntaxhighlight lang="lua">float float float GetVehicleRotation ( vehicle )</syntaxhighlight>
<syntaxhighlight lang="lua">float float float getVehicleRotation ( vehicle theVehicle )</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===
*'''vehicle''': The [[vehicle]] whose rotation you want to retrieve.
*'''theVehicle''': The [[vehicle]] whose rotation you want to retrieve.


===Returns===
===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.
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==
==Example==
This example creates a vehicle and gets it's rotation:
This example creates a vehicle and gets its rotation:
<syntaxhighlight lang="lua">local newcar = createVehicle ( 520, 1024, 1024, 1024 ) -- create a Hydra
<syntaxhighlight lang="lua">local newHydra = 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 ( newHydra ) -- 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: " .. rx .. " " .. ry .. " " .. rz ) -- output the rotations
</syntaxhighlight>
</syntaxhighlight>


==See Also==
==See Also==
{{Vehicle functions}}
{{Vehicle functions}}

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


Retrieved from "https://wiki.multitheftauto.com/wiki/GetVehicleRotation?oldid=64120"