setPedAnimation | Multi Theft Auto: Wiki Skip to content
Multi Theft Auto: Wiki

setPedAnimation

Client-side
Server-side
Shared

Pair: getPedAnimation

Manual Review Required

Please finish this page using the corresponding Old Wiki article. Go to Contribution guidelines for more information.

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

Caution

It is possible that an animation will be cancelled if you use setElementFrozen on the ped, but this does not happen all the time.

OOP Syntax Help! I don't understand this!

  • Method:ped:setAnimation(...)

Syntax 

bool setPedAnimation ( ped thePed, [ string block = nil, string anim = nil, int time = -1, bool loop = true, bool updatePosition = true, bool interruptable = true, bool freezeLastFrame = true, int blendTime = 250, bool retainPedState = false ] )
Required Arguments
  • thePed: the player or ped you want to apply an animation to.
Optional Arguments

NOTE: When using optional arguments, you might need to supply all arguments before the one you wish to use.

  • block (default: nil): the animation block's name.
  • anim (default: nil): the name of the animation within the block.
  • time (default: -1): how long the animation will run for in milliseconds.
  • loop (default: true): indicates whether or not the animation will loop.
  • updatePosition (default: true): will change the actual coordinates of the ped according to the animation. Use this for e.g. walking animations.
  • interruptable (default: true): if set to false other tasks wont be able to interupt the animation. Setting this to 'false' also gives this function more power to override other animations that are running. For example, squatting after a jump can be terminated.
  • freezeLastFrame (default: true): if set to true after animation the last frame will be frozen, otherwise the animation will end and controls will return.
  • blendTime (default: 250): how long the animation will mixed with the previous one in milliseconds.
  • retainPedState (default: false): MISSING_PARAM_DESC

Returns

  • bool: value

Returns true if succesful, false otherwise.

Code Examples

shared

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

function makePed()
  local thePed = createPed(56, 1, 1, 4, 315)
  setPedAnimation(thePed, "ped", "WOMAN_walknorm")
end
addCommandHandler("makemyped", makePed)

Issues

ID Description
1110 retainPedState in setPedAnimation() does not work when latency reduction is set to 1
953 setPedAnimation() "interrupt" and "time" has no effect in certain situations
467 Ped animations don't sync for new players
463 setPedAnimation() does not work when a ped is attached and floating in air
1173 setPedAnimation() removes player jetpack
884 setPedAnimation() messes up collisions of peds inside vehicles

See Also

Ped Functions
Ped Events
Reference