SetPedAnimation: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 5: Line 5:


==Syntax==
==Syntax==
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
bool setPedAnimation ( ped thePed, [string block=nil, string name=nil, int uncontrollableTime=-1,bool loop=true, bool updatePosition=true, bool interruptible=true] )
bool setPedAnimation ( ped thePed, [string block=nil, string name=nil, float blendDelta=1.0,bool loop=true, bool updatePosition=true] )
</syntaxhighlight>
</syntaxhighlight>


Line 15: Line 16:
*'''block:''' the [[Animations|animation]] block's name.
*'''block:''' the [[Animations|animation]] block's name.
*'''anim:''' the name of the [[Animations|animation]] within the block.
*'''anim:''' the name of the [[Animations|animation]] within the block.
*'''uncontrollableTime:''' the duration that player control is disabled for. Defaults to -1, which is infinite.
*'''blendDelta:''' the speed at which the previous and current animation are blended.
*'''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
</section>
 
<section name="Client" class="client" show="false">
<syntaxhighlight lang="lua">
bool setPedAnimation ( ped thePed, [string block=nil, string name=nil, float blendDelta=1.0,bool loop=true, bool updatePosition=true,function callbackFunction, var arguments, ...] )
</syntaxhighlight>
 
===Required Arguments===
*'''thePed:''' the player or ped you want to apply an animation to.
 
===Optional Arguments===
*'''block:''' the [[Animations|animation]] block's name.
*'''anim:''' the name of the [[Animations|animation]] within the block.
*'''blendDelta:''' the speed at which the previous and current animation are blended.
*'''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.
*'''callbackFunction''' A function that is called when the animation is finished
*'''arguments''' Any arguments you want to pass to the callbackFunction, eg: animation name
</section>


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

Revision as of 23:36, 3 June 2009

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

Syntax

Click to collapse [-]
Server
bool setPedAnimation ( ped thePed, [string block=nil, string name=nil, float blendDelta=1.0,bool loop=true, bool updatePosition=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.
  • blendDelta: the speed at which the previous and current animation are blended.
  • 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.
Click to expand [+]
Client

Returns

Returns true if succesful, false otherwise.

Example

Click to collapse [-]
Client

This example creates a ped, rotates them, and makes them walk: 

function makePed ( )
   ped1 = createPed ( 56, 1, 1, 4 )
   setPedRotation( ped1, 315 )
   setPedAnimation( ped1, "ped", "WOMAN_walknorm")
end
addEventHandler ( "onResourceStart", getRootElement(), makePed )

See Also


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