SetPedAnimationSpeed: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
m (add new limit docs)
m (add warning for numbers greater than 1)
Line 16: Line 16:
===Optional Arguments===
===Optional Arguments===
*'''anim:''' the animation name it will affect.
*'''anim:''' the animation name it will affect.
*'''speed:''' a [[float]] containing the speed between 0.0–1.0 you want to apply to the animation. ''This limitation may be adjusted in the future, so do not provide speeds outside this boundary.'' {{New feature/item|3.0160|1.5.7|20395|The limit is now 0.0 to 10.0.}}
*'''speed:''' a [[float]] containing the speed between 0.0–1.0 you want to apply to the animation. ''This limitation may be adjusted in the future, so do not provide speeds outside this boundary.'' {{New feature/item|3.0160|1.5.7|20395|The limit is now 0.0 to 10.0.}} {{Warning|Setting '''speed''' higher than '''1''' can cause issues with some animations.}}


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

Revision as of 19:03, 26 January 2020

Sets the speed of a currently running animation for a particular player or ped.

Syntax

bool setPedAnimationSpeed ( ped thePed [, string anim = "", float speed = 1.0 ] )

OOP Syntax Help! I don't understand this!

Method: ped:setAnimationSpeed(...)


Required Arguments

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

Optional Arguments

  • anim: the animation name it will affect.
  • speed: a float containing the speed between 0.0–1.0 you want to apply to the animation. This limitation may be adjusted in the future, so do not provide speeds outside this boundary. The limit is now 0.0 to 10.0.
[[|link=|]] Warning: Setting speed higher than 1 can cause issues with some animations.

Returns

Returns true if successful, false otherwise.

Example

Click to collapse [-]
Server

In this example we give the animation of dancing to the player and after 5 seconds it becomes 0.2s slower.

addCommandHandler('dance',
  function( player, cmd )
      setPedAnimation( player, 'DANCING', 'DAN_Down_A', -1 )
      source = player
      setTimer(function() 
          setPedAnimationSpeed( source, 'DAN_Down_A', 0.2 )
      end,5000,1)
   end
)

See Also