GetElementBoneMatrix: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
mNo edit summary
No edit summary
Line 1: Line 1:
{{Client function}}
{{Client function}}
__NOTOC__  
__NOTOC__  
{{New feature/item|3.0159|1.5.8|20704|This function returns the transformation matrix of a specific bone. Currently the following element types are accepted:
This function returns the transformation matrix of a specific bone. Currently the [[Element/Player|Player]] and [[Element/Ped|Ped]] element types are accepted.
* [[Element/Player|Player]]
 
* [[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]]}}
{{Tip|For [[matrix]] manipulation which goes beyond the basic examples given on this page, see the [[Lua matrix library]]. Using the built-in [[matrix]] class is also recommended.}}
{{Tip|For [[matrix]] manipulation which goes beyond the basic examples given on this page, see the [[Lua matrix library]]. Using the built-in [[matrix]] class is also recommended.}}


==Syntax==
==Syntax==
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
table getElementBoneMatrix ( element theElement, int bone )
table getElementBoneMatrix ( element theElement, int boneId )
</syntaxhighlight>
</syntaxhighlight>


===Required Arguments===  
===Required Arguments===  
*'''theElement:''' the element to get the bone matrix on.
*'''theElement:''' the [[element]] to get the bone matrix on.
*'''bone:''' the ID of the bone to get the matrix of. See [[Bone IDs]]
*'''boneId:''' the ID of the bone to get the matrix of. See [[Bone IDs]].


===Returns===
===Returns===
Line 22: Line 20:
==Example==  
==Example==  
{{Needs Example}}
{{Needs Example}}
==Requirements==
{{Requirements|n/a|1.5.8-9.20704|}}


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

Revision as of 15:12, 19 September 2021

This function returns the transformation matrix of a specific bone. Currently the Player and Ped element types are accepted.


[[{{{image}}}|link=|]] Tip: If you want to attach an element to a bone, see attachElementToBone.
[[{{{image}}}|link=|]] Tip: For matrix manipulation which goes beyond the basic examples given on this page, see the Lua matrix library. Using the built-in matrix class is also recommended.

Syntax

table getElementBoneMatrix ( element theElement, int boneId )

Required Arguments

  • theElement: the element to get the bone matrix on.
  • boneId: the ID of the bone to get the matrix of. See Bone IDs.

Returns

Returns a multi-dimensional array (which can be transformed into a proper matrix class using Matrix.create method) containing a 4x4 matrix. Returns false if invalid arguments were passed.

Example

Accessories-text-editor.png Script Example Missing Function GetElementBoneMatrix needs a script example, help out by writing one.
Before submitting check out Editing Guidelines Script Examples.


Requirements

Minimum server version n/a
Minimum client version 1.5.8-9.20704

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

Shared


Retrieved from "https://wiki.multitheftauto.com/wiki/GetElementBoneMatrix?oldid=72107"