getElementBoneQuaternion | Multi Theft Auto: Wiki Skip to content
Multi Theft Auto: Wiki

getElementBoneQuaternion

Client-side
Server-side
Shared

Pair: setElementBoneQuaternion

Added in 1.6.0 r22741

This function retrieves how a particular bone rotates in relation to the element. This can be a player or ped.

Tip

The use of quaternions are more effective and do not generate issues like gimbal lock that might arise with Euler angles, so they are a preferable choice for rotation.

Syntax 

​float|false, ​float, ​float, ​float getElementBoneQuaternion ( ​element ped, ​int bone )
Required arguments
  • ped: The element from which the bone's rotation will be retrieved.
  • bone: The ID of the bone to retrieve the quaternion of. See Bone IDs.

Returns

Returns four floats: x, y, z, w, or false if invalid arguments were passed.

  • float|false: The quaternion's coefficient of the 𝑖 component, representing rotation around the x-axis.
  • float: The quaternion's coefficient of the 𝑗 component, representing rotation around the y-axis.
  • float: The quaternion's coefficient of the 𝑘 component, representing rotation around the z-axis.
  • float: The real part of the quaternion, which is linked to the angle of rotation.

Code Examples

client

This example retrieves the rotation of the player's head in quaternion. The retrieved values can be used for calculations.

local playerBone = 1
local playerBoneX, playerBoneY, playerBoneZ, playerBoneW


addEventHandler("onClientResourceStart", resourceRoot, function()
    playerBoneX, playerBoneY, playerBoneZ, playerBoneW = getElementBoneQuaternion(localPlayer, playerBone)
end)

See Also

Element Functions
Element Events
Reference