SetElementBonePosition: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
{{Client function}} | {{Client function}} | ||
This function sets the position of a bone to the specified coordinates. Currently the | This function sets the position of a bone to the specified coordinates. 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]].}} | {{Tip|If you want to attach an element to a bone, see [[attachElementToBone]].}} | ||
Line 16: | Line 14: | ||
*'''theElement:''' the element to set the bone position on. | *'''theElement:''' the element to set the bone position on. | ||
*'''bone:''' the ID of the bone to set the position of. See [[Bone IDs]]. | *'''bone:''' the ID of the bone to set the position of. See [[Bone IDs]]. | ||
*'''x:''' The | *'''x:''' The X coordinate of the destination. | ||
*'''y:''' The | *'''y:''' The Y coordinate of the destination. | ||
*'''z:''' The | *'''z:''' The Z coordinate of the destination. | ||
===Returns=== | ===Returns=== | ||
Line 42: | Line 40: | ||
addCommandHandler ("setbonepos", setBonePosition) | addCommandHandler ("setbonepos", setBonePosition) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
==Requirements== | |||
{{Requirements|n/a|1.5.8-9.20704|}} | |||
==See Also== | ==See Also== | ||
{{Client_element_functions}} | {{Client_element_functions}} |
Revision as of 14:37, 19 September 2021
This function sets the position of a bone to the specified coordinates. Currently the Player and Ped element types are accepted.
Tip: If you want to attach an element to a bone, see attachElementToBone. |
Syntax
bool setElementBonePosition ( element theElement, int bone, float x, float y, float z )
Required Arguments
- theElement: the element to set the bone position on.
- bone: the ID of the bone to set the position of. See Bone IDs.
- x: The X coordinate of the destination.
- y: The Y coordinate of the destination.
- z: The Z coordinate of the destination.
Returns
Returns true if the function was successful, false otherwise.
Example
This example is a command where the player should input the bone ID and the XYZ coordinates to set one of his bones' position.
function setBonePosition (commandName, boneId, x, y, z) if (not boneId or not x or not y or not z) then outputChatBox ("Syntax: /setbonepos boneID x y z", 255, 25, 25) return false end if (not tonumber(id) or not tonumber(x) or not tonumber(y) or not tonumber(z)) then outputChatBox ("Command arguments should be numbers!", 255, 25, 25) return false end setElementBonePosition (localPlayer, ID, x, y, z) outputChatBox ("Bone position set successfully!", 0, 255, 0) end addCommandHandler ("setbonepos", setBonePosition)
Requirements
This template will be deleted.
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