SetElementBonePosition: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
mNo edit summary
No edit summary
Line 1: Line 1:
__NOTOC__
__NOTOC__
{{Client function}}
{{Client function}}
{{New feature/item|3.0159|1.5.8|20704|This function sets the position of a bone to the specified coordinates. Currently the following element types are accepted:
This function sets the position of a bone to the specified coordinates. Currently the following element types are accepted:
* [[Element/Player|Player]]
* [[Element/Player|Player]]
* [[Element/Ped|Ped]]
* [[Element/Ped|Ped]]
}}
 
{{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]].}}
{{Note|You need to use this function together with [[onClientPedsProcessed]].}}
{{Note|You need to use this function together with [[onClientPedsProcessed]].}}


Line 15: Line 15:
===Required Arguments===
===Required Arguments===
*'''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 coordinate of the destination.
*'''x:''' The x coordinate of the destination.
*'''y:''' The y coordinate of the destination.
*'''y:''' The y coordinate of the destination.
Line 24: Line 24:


==Example==
==Example==
This example is a command where the player should input the bone ID, x, y, z to set one of his bones' position.
This example is a command where the player should input the bone ID and the XYZ coordinates to set one of his bones' position.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
function setBonePosition(cmd, ID, x, y, z)
function setBonePosition (commandName, boneId, x, y, z)
     if (not ID or not x or not y or not z) then
     if (not boneId or not x or not y or not z) then
         outputChatBox("Syntax: '/setbonepos ID x y z'", 255, 25, 25)
         outputChatBox ("Syntax: /setbonepos boneID x y z", 255, 25, 25)
         return false
         return false
     end
     end
     if (not tonumber(ID) or not tonumber(x) or not tonumber(y) or not tonumber(z)) then
     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)
         outputChatBox ("Command arguments should be numbers!", 255, 25, 25)
         return false
         return false
     end
     end
     setElementBonePosition(localPlayer, ID, x, y, z)
 
     outputChatBox("Bone position set successfully", 0, 255, 0)
     setElementBonePosition (localPlayer, ID, x, y, z)
     outputChatBox ("Bone position set successfully!", 0, 255, 0)
end
end
addCommandHandler("setbonepos", setBonePosition)
 
addCommandHandler ("setbonepos", setBonePosition)
</syntaxhighlight>
</syntaxhighlight>


==See Also==
==See Also==
{{Client_element_functions}}
{{Client_element_functions}}

Revision as of 14:32, 19 September 2021

This function sets the position of a bone to the specified coordinates. Currently the following element types are accepted:


[[{{{image}}}|link=|]] Tip: If you want to attach an element to a bone, see attachElementToBone.
[[{{{image}}}|link=|]] Note: You need to use this function together with onClientPedsProcessed.

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)

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/SetElementBonePosition?oldid=72097"