SetPedAnimation: Difference between revisions

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


Sets the current animation of a player or ped.
Sets the current animation of a player or ped.  Not specifying the type of animation will automatically cancel the current one.


==Syntax==
==Syntax==
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
bool setPedAnimation ( ped thePed, string block, string anim, [ bool loop = false, bool updatePosition = false ] )
bool setPedAnimation ( ped thePed, [string block=nil, string name=nil, int time=-1,bool loop=true, bool updatePosition=true, bool interuptable=true) )
</syntaxhighlight>
Or, to stop the current animation:
<syntaxhighlight lang="lua">
bool setPedAnimation ( ped thePed, bool false )
</syntaxhighlight>
</syntaxhighlight>


===Required Arguments===
===Required Arguments===
*'''thePed:''' the player or ped you want to apply an animation to.
*'''thePed:''' the player or ped you want to apply an animation to.
*'''block:''' the animation block's name.
*'''anim:''' the name of the animation within the block.


===Optional Arguments===
===Optional Arguments===
*'''block:''' the [[Animations|animation]] block's name.
*'''anim:''' the name of the [[Animations|animation]] within the block.
*'''time:''' the duration for the animation.  Defaults to -1, which is the default time.
*'''loop:''' indicates whether or not the animation will loop.
*'''loop:''' indicates whether or not the animation will loop.
*'''updatePosition:''' will change the actual coordinates of the ped according to the animation. Use this for e.g. walking animations.
*'''updatePosition:''' will change the actual coordinates of the ped according to the animation. Use this for e.g. walking animations.
*'''interuptable:''' Defines whether the animation can be interrupted by normal movements


===Returns===
===Returns===

Revision as of 18:23, 21 June 2008

Sets the current animation of a player or ped. Not specifying the type of animation will automatically cancel the current one.

Syntax

bool setPedAnimation ( ped thePed, [string block=nil, string name=nil, int time=-1,bool loop=true, bool updatePosition=true, bool interuptable=true) )

Required Arguments

  • thePed: the player or ped you want to apply an animation to.

Optional Arguments

  • block: the animation block's name.
  • anim: the name of the animation within the block.
  • time: the duration for the animation. Defaults to -1, which is the default time.
  • loop: indicates whether or not the animation will loop.
  • updatePosition: will change the actual coordinates of the ped according to the animation. Use this for e.g. walking animations.
  • interuptable: Defines whether the animation can be interrupted by normal movements

Returns

Returns true if succesful, false otherwise.

Example

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/SetPedAnimation?oldid=17497"