GetPlayerBoneLocation: Difference between revisions

From Onset Developer Wiki
(Created page with "{{Info|Function|Client|1.0}} {{FuncDescription|__EDIT_ME__}} {{FuncSyntax|GetPlayerBoneLocation(player, BoneName [, BoneSpace])}} {{FuncParameters}} {{FuncParam|player|__ED...")
 
No edit summary
 
(One intermediate revision by one other user not shown)
Line 1: Line 1:
{{Info|Function|Client|1.0}}
{{Info|Function|Client|1.0}}


{{FuncDescription|__EDIT_ME__}}
{{FuncDescription|This function returns the bone location of the player.}}


{{FuncSyntax|GetPlayerBoneLocation(player, BoneName [, BoneSpace])}}
{{FuncSyntax|GetPlayerBoneLocation(player, BoneName [, BoneSpace = 1])}}


{{FuncParameters}}
{{FuncParameters}}
{{FuncParam|player|__EDIT_ME__}}
{{FuncParam|player|The player identifier}}
{{FuncParam|BoneName |__EDIT_ME__}}
{{FuncParam|BoneName |The bone name}}
{{FuncParamOptional|BoneSpace|__EDIT_ME__}}
{{FuncParamOptional|BoneSpace|1 = World Space, 2 = Local Space}}


{{FuncReturnValue|__EDIT_ME__}}
{{FuncReturnValue|Returns X, Y, Z of the bone location.}}


== Example ==
== Example ==
__EDIT_ME__
<syntaxhighlight lang="Lua">
GetPlayerBoneLocation(playerId, boneName)
</syntaxhighlight>


{{RelatedFunctions}}
{{RelatedFunctions}}
__EDIT_ME__
__EDIT_ME__

Latest revision as of 19:32, 18 January 2020

GetPlayerBoneLocation

Type: Function
Context: Client
Introduced: v1.0

Description

This function returns the bone location of the player.

Syntax

{{{1}}}

Parameters

  • player
    The player identifier
  • BoneName
    The bone name
  • World Space, 2 = Local Space (optional)
    {{{2}}}

Return Value

  • Returns X, Y, Z of the bone location.

Example

GetPlayerBoneLocation(playerId, boneName)

See also

__EDIT_ME__