SetElementBoneRotation: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
|||
(16 intermediate revisions by 4 users not shown) | |||
Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
{{Client function}} | {{Client function}} | ||
{{ | {{Added feature/item|1.5.9|1.5.8|20704|This function sets the rotation of a specific bone relative to the element. Currently the [[Element/Player|Player]] and [[Element/Ped|Ped]] element types are accepted.}} | ||
{{Tip|If you want to attach an element to a bone, see [[attachElementToBone]].}} | |||
{{Note|[[updateElementRpHAnim]] must be called after this function to apply bone rotation.}} | |||
}} | |||
{{Tip|If you want to attach an element to a bone, see [[attachElementToBone]]}} | |||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
bool setElementBoneRotation ( element theElement, int | bool setElementBoneRotation ( element theElement, int boneId, float yaw, float pitch, float roll ) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
Line 15: | Line 13: | ||
===Required Arguments=== | ===Required Arguments=== | ||
*'''theElement:''' | *'''theElement:''' The [[element]] to set the bone rotation on. | ||
*''' | *'''boneId:''' The ID of the bone to set the rotation of. See [[Bone IDs]]. | ||
*'''yaw:''' | *'''yaw:''' The yaw rotation value. | ||
*'''pitch:''' | *'''pitch:''' The pitch rotation value. | ||
*'''roll:''' | *'''roll:''' The roll rotation value. | ||
===Returns=== | ===Returns=== | ||
Returns ''true'' if the function was successful, ''false'' otherwise. | Returns ''true'' if the function was successful, ''false'' otherwise. | ||
==Example== | ==Example== | ||
This example shows how you can turn a local player into a so-called 'Helicopter': | |||
<syntaxhighlight lang="lua">local | <syntaxhighlight lang="lua"> | ||
local customYaw = 0 | |||
local shoulders = {22, 32} | |||
setTimer(function() | setTimer (function () | ||
customYaw = customYaw + 20 | |||
end, 10, 0) | end, 10, 0) | ||
local | function changeBoneRotation () | ||
local yaw, pitch, roll = getElementBoneRotation (localPlayer, 2) -- Get the element's bone rotation | |||
setElementBoneRotation(localPlayer, 2, customYaw, pitch, roll) -- Set the elements' bone rotation with custom yaw | |||
for key, value in pairs (shoulders) do | |||
setElementBoneRotation(localPlayer, value, 0, 0, 0) -- Update the ped's shoulders rotation | |||
end | |||
updateElementRpHAnim(localPlayer) -- Update the ped's bone animations | |||
end | end | ||
addEventHandler ("onClientPedsProcessed", getRootElement(), changeBoneRotation) | |||
</syntaxhighlight> | |||
==Requirements== | |||
{{Requirements|n/a|1.5.8-9.20704|}} | |||
==See Also== | ==See Also== | ||
{{Client_element_functions}} | {{Client_element_functions}} |
Latest revision as of 20:34, 23 September 2021
This function sets the rotation of a specific bone relative to the element. Currently the Player and Ped element types are accepted.
Tip: If you want to attach an element to a bone, see attachElementToBone. |
Syntax
bool setElementBoneRotation ( element theElement, int boneId, float yaw, float pitch, float roll )
Required Arguments
- theElement: The element to set the bone rotation on.
- boneId: The ID of the bone to set the rotation of. See Bone IDs.
- yaw: The yaw rotation value.
- pitch: The pitch rotation value.
- roll: The roll rotation value.
Returns
Returns true if the function was successful, false otherwise.
Example
This example shows how you can turn a local player into a so-called 'Helicopter':
local customYaw = 0 local shoulders = {22, 32} setTimer (function () customYaw = customYaw + 20 end, 10, 0) function changeBoneRotation () local yaw, pitch, roll = getElementBoneRotation (localPlayer, 2) -- Get the element's bone rotation setElementBoneRotation(localPlayer, 2, customYaw, pitch, roll) -- Set the elements' bone rotation with custom yaw for key, value in pairs (shoulders) do setElementBoneRotation(localPlayer, value, 0, 0, 0) -- Update the ped's shoulders rotation end updateElementRpHAnim(localPlayer) -- Update the ped's bone animations end addEventHandler ("onClientPedsProcessed", getRootElement(), changeBoneRotation)
Requirements
Note: Using this feature requires the resource to have the above minimum version declared in the meta.xml <min_mta_version> section. e.g. <min_mta_version client="1.5.8-9.20704" />
See Also
- getElementBoneMatrix
- getElementBonePosition
- getElementBoneRotation
- getElementBoundingBox
- getElementDistanceFromCentreOfMassToBaseOfModel
- getElementLighting
- getElementRadius
- isElementCollidableWith
- isElementLocal
- isElementOnScreen
- isElementStreamable
- isElementStreamedIn
- isElementSyncer
- isElementWaitingForGroundToLoad
- setElementBoneMatrix
- setElementBonePosition
- setElementBoneRotation
- setElementCollidableWith
- setElementStreamable
- updateElementRpHAnim
- Shared
- attachElements
- createElement
- destroyElement
- detachElements
- getAttachedElements
- getElementAlpha
- getElementAttachedOffsets
- getElementAttachedTo
- getElementByIndex
- getElementByID
- getElementChild
- getElementChildren
- getElementChildrenCount
- getElementCollisionsEnabled
- getElementColShape
- getElementData
- getAllElementData
- hasElementData
- getElementDimension
- getElementHealth
- getElementID
- getElementInterior
- getElementMatrix
- getElementModel
- getElementParent
- getElementPosition
- getElementRotation
- getElementsByType
- getElementsWithinColShape
- getElementsWithinRange
- getElementType
- getElementVelocity
- getLowLODElement
- getRootElement
- isElement
- isElementAttached
- isElementCallPropagationEnabled
- isElementDoubleSided
- isElementFrozen
- isElementInWater
- isElementLowLOD
- isElementWithinColShape
- isElementWithinMarker
- setElementAlpha
- setElementAngularVelocity
- getElementAngularVelocity
- setElementAttachedOffsets
- setElementCallPropagationEnabled
- setElementCollisionsEnabled
- setElementData
- setElementDimension
- setElementDoubleSided
- setElementFrozen
- setElementHealth
- setElementID
- setElementInterior
- setElementModel
- setElementParent
- setElementPosition
- setElementRotation
- setElementVelocity
- setLowLODElement
- getPedContactElement
- getResourceDynamicElementRoot
- getResourceRootElement