GetPedAnimationData: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
(Remove obsolete Requirements section)
 
(16 intermediate revisions by 10 users not shown)
Line 1: Line 1:
__NOTOC__
__NOTOC__
{{Client function}}
{{Client function}}
 
{{Disabled}}
Gets the animation data of a player or ped that was set using [[setPedAnimation]] or [[blendPedAnimation]].
This function is used to return the animation data of a [[player]] or [[ped]] that was set using [[setPedAnimation]].


==Syntax==
==Syntax==
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
table getPedAnimationData ( ped thePed, string dataType )
string getPedAnimationData ( ped thePed )
</syntaxhighlight>
</syntaxhighlight>


===Required Arguments===
===Required Arguments===
*'''thePed:''' the player or ped you want to get the animation data of.
*'''thePed:''' the player or ped you want to get the animation data of.
*'''dataType:''' A string representing the type of data you want to retrieve:
==Data-types==
*'''name:''' string - name of animation.
*'''blockName:''' string - name of animation block.
*'''loop:''' boolean - looping.
*'''updatePosition:''' boolean - updating position.
*'''interruptable:''' boolean - interruptable.
*'''time:''' float - duration.
*'''startTime:''' float - starting point.
*'''finished:''' boolean - finished playing.
*'''speed:''' float - speed.
*'''blendSpeed:''' float - blending speed.


===Returns===
===Returns===
Returns various arguments depending on the 'dataType' specified.
Returns 2 <!-- Returns a string [[table]] -->[[string]]s containing information about [[animations]]. These keys are present below <!-- in the table --> :
*'''name:''' string - name of the animation
*'''block_name:''' string - name of animation block
<!-- For some reason it doesn't output these *'''loop:''' boolean - is animation looping?
*'''update_position:''' boolean - updating position
*'''interruptible:''' boolean - is animation interruptible?
*'''time:''' float - duration of the animation
*'''start_time:''' float - starting point
*'''finished:''' boolean - has animation finished playing?
*'''speed:''' float - speed
*'''blend_speed:''' float - blending speed -->


==Example==
===Example===
This example adds a command to get the local player [[animations | animation]] data.
<syntaxhighlight lang="lua">function animData()
    local data = getPedAnimationData(localPlayer)
    if data then
          outputChatBox(data)
    else
          outputChatBox("Sorry, but you're not doing thing!")
    end
end
addCommandHandler("getAnimData",animData)
</syntaxhighlight>


==See Also==
==See Also==
{{Ped_functions}}
{{Client ped functions}}

Latest revision as of 15:32, 7 November 2024

Dialog-warning.png Function has been disabled.

This function is used to return the animation data of a player or ped that was set using setPedAnimation.

Syntax

string getPedAnimationData ( ped thePed )

Required Arguments

  • thePed: the player or ped you want to get the animation data of.

Returns

Returns 2 strings containing information about animations. These keys are present below  :

  • name: string - name of the animation
  • block_name: string - name of animation block

Example

This example adds a command to get the local player animation data. 

function animData()
     local data = getPedAnimationData(localPlayer)
     if data then
          outputChatBox(data)
     else
          outputChatBox("Sorry, but you're not doing thing!")
     end
end
addCommandHandler("getAnimData",animData)

See Also



Retrieved from "https://wiki.multitheftauto.com/wiki/GetPedAnimationData?oldid=81019"