SetElementRotation: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
mNo edit summary
No edit summary
Line 7: Line 7:
==Syntax==
==Syntax==
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
bool setElementRotation ( element theElement, float rotX, float rotY, float rotZ )       
bool setElementRotation ( element theElement, float rotX, float rotY, float rotZ [, string rotOrder])       
</syntaxhighlight>  
</syntaxhighlight>  


Line 16: Line 16:
*'''rotZ:''' The element's rotation around the z axis in degrees
*'''rotZ:''' The element's rotation around the z axis in degrees


===Optional Arguments===
{{New feature|3|1.1|
From MTA 1.1 onwards:
*'''rotOrder:''' A string representing the rotation order desired when interpreting the provided [http://en.wikipedia.org/wiki/Euler_angles euler angles]. If omitted, default value is ''"default"''. Allowed values are:
**''"default":'' default MTA behavior prior to 1.1, where rotation order depends on element type
**''"ZXY:"'' rotation about the Z axis (''up''), then about the resulting X axis (''right'') and finally about the resulting Y axis (''front''). This is the default rotation order for [[object|objects]]
**''"ZYX:"'' rotation about the Z axis (''up''), then about the resulting Y axis (''front''), and finally about the resulting X axis (''right'') and finally about . This is the default rotation order for [[vehicle|vehicles]]
}}
The default rotation order for peds/players is -Z-Y-X but this rotation order (set using ''"default"'' on peds) can not be set manually on other element types since it only exists due to historical and backward compatibility reasons.
===Returns===
===Returns===
Returns ''true'' if the element rotation was successfully set and ''false'' otherwise.
Returns ''true'' if the element rotation was successfully set and ''false'' otherwise.

Revision as of 18:12, 9 November 2010

Sets the rotation of elements according to the world (does not work with players that are on the ground).

Only clientside before 1.0.4

Syntax

bool setElementRotation ( element theElement, float rotX, float rotY, float rotZ [, string rotOrder])

Required Arguments

  • theElement: The element whose rotation will be set
  • rotX: The element's rotation around the x axis in degrees
  • rotY: The element's rotation around the y axis in degrees
  • rotZ: The element's rotation around the z axis in degrees

Optional Arguments

From MTA 1.1 onwards:

  • rotOrder: A string representing the rotation order desired when interpreting the provided euler angles. If omitted, default value is "default". Allowed values are:
    • "default": default MTA behavior prior to 1.1, where rotation order depends on element type
    • "ZXY:" rotation about the Z axis (up), then about the resulting X axis (right) and finally about the resulting Y axis (front). This is the default rotation order for objects
    • "ZYX:" rotation about the Z axis (up), then about the resulting Y axis (front), and finally about the resulting X axis (right) and finally about . This is the default rotation order for vehicles

The default rotation order for peds/players is -Z-Y-X but this rotation order (set using "default" on peds) can not be set manually on other element types since it only exists due to historical and backward compatibility reasons.

Returns

Returns true if the element rotation was successfully set and false otherwise.

Example

When a player used the command "turn" and they are the driver of a vehicle the vehicle will rotate 10 degrees clockwise

Click to collapse [-]
Client
local localPlayer = getLocalPlayer()
function carRotate( )
    if isPedInVehicle(localPlayer) then -- if the local client is in a vehicle
        localVehicle = getPedOccupiedVehicle(localPlayer)
        if getVehicleController(localVehicle) == localPlayer then -- if the local client is the controller (driver) of the vehicle
            local rotX, rotY, rotZ = getElementRotation(localVehicle) -- get the local client's vehicle rotation
            setElementRotation(localVehicle,rotX,rotY,rotZ+10) -- turn the vehicle 10 degrees clockwise
         end
    end
end
addCommandHandler ( "turn", carRotate )

See Also



Retrieved from "https://wiki.multitheftauto.com/wiki/SetElementRotation?oldid=24494"