GetPedAnimation: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
mNo edit summary
No edit summary
Line 2: Line 2:
{{Client function}}
{{Client function}}


Gets the animation of a player or ped that was set using [[setPedAnimation]].
Gets the animation data of a player or ped that was set using [[setPedAnimation]] or [[blendPedAnimation]].


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


===Required Arguments===
===Required Arguments===
*'''thePed:''' the player or ped you want to get the animation 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 two ''strings'': the first is the name of the block, the second is the name of the animation. Returns ''false'' if there was an error or if the ped is not doing an animation.
Returns various arguments depending on the 'dataType' specified.


==Example==
==Example==

Revision as of 17:48, 10 June 2009

Gets the animation data of a player or ped that was set using setPedAnimation or blendPedAnimation.

Syntax

... getPedAnimationData ( ped thePed, string dataType )

Required Arguments

  • 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 various arguments depending on the 'dataType' specified.

Example

See Also