ScriptEvent:idleAnim

From Mod Wiki

Parameters

integer channel -- Channel to play the animation on.
string anim -- Name of the animation to play.

Result

boolean

Supported By

idActor

Comments

  • If the opposing channel is already in idle state with the same animation, both channels will start the animation, and the other channel will sync to the one specified.
  • If the opposing channel is cycling the same animation, this channel will sync to the other channel.

Functionality

Attempts to cycle the specified animation on the given channel, and returns whether it succeeded or not.