SetPedAnimationProgress: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
m (aplly --> apply)
No edit summary
Line 6: Line 6:
==Syntax==
==Syntax==
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
bool setPedAnimationProgress ( ped thePed, string anim, float progress)
bool setPedAnimationProgress ( ped thePed [, string anim, float progress] )
</syntaxhighlight>
</syntaxhighlight>


===Required Arguments===
===Required Arguments===
*'''thePed:''' the player or ped you want to change animation progress.
*'''thePed:''' the player or ped you want to change animation progress.
*'''anim:''' the animation name, currently applied to ped.
 
*'''progress:''' current animation progress you want to apply, value from 0.0 to 1.0.
===Optional Arguments===
*'''anim:''' the animation name currently applied to ped, if not supplied, the animation will stop
*'''progress:''' current animation progress you want to apply, value from 0.0 to 1.0, if not supplied will default to 0.0


===Returns===
===Returns===
Returns ''true'' if succesful, ''false'' otherwise.
Returns ''true'' if successful, ''false'' otherwise.


==Example==  
==Example==  

Revision as of 23:09, 28 February 2012

Sets the current animation progress of a player or ped.

Syntax

bool setPedAnimationProgress ( ped thePed [, string anim, float progress] )

Required Arguments

  • thePed: the player or ped you want to change animation progress.

Optional Arguments

  • anim: the animation name currently applied to ped, if not supplied, the animation will stop
  • progress: current animation progress you want to apply, value from 0.0 to 1.0, if not supplied will default to 0.0

Returns

Returns true if successful, false otherwise.

Example

Click to collapse [-]
Server

This example creates a ped, apply animation to it, and "freeze" the animation at half of overall animation time.

function animRender( ped1 )
        setPedAnimationProgress(ped1, "M_SMKSTND_LOOP", 0.5)
        setTimer ( animRender, 50, 1, ped1 )
end

function makePed()
    local ped1 = createPed(56, 1, 1, 4)
    setPedAnimation( ped1, "SMOKING", "M_SMKSTND_LOOP")
    setTimer ( animRender, 50, 1, ped1 )
end
addCommandHandler("makemyped", makePed)

See Also