PlayIdleEx

From GECK
Jump to: navigation, search

A function added by the JIP NVSE Plugin.

Description

An alternate, extended version of the vanilla function PlayIdle - causes the calling actor to play a specified Idle Animation. Unlike the latter, which takes a string argument comprising the name of the Idle Animation to be played, this function takes an Editor ID.

Moreover, the behavior of this function is determined by the passed argument:

  • If a "parent" animation (i.e. grouping one or more "child" animations, or sub-parents), the function will randomly pick and play the first animation whose conditions (if any) evaluate as true.
  • If a "child" animation (i.e. not grouping other animations), the function will force-play that animation, ignoring conditions.
  • If the argument is entirely omitted, the function behaves exactly the same as PickIdle.

Syntax

[help]
reference.PlayIdleEx idleAnim:ref

Example

actorRef.PlayIdleEx MTHitHeadBForce

Force-plays the MTHitHeadBForce on actorRef (conditions, if any, are ignored).

actorRef.PlayIdleEx 3rdPersonHitReactions

Randomly picks the first child animation of 3rdPersonHitReactions whose conditions evaluate as true, and plays it on actorRef.

See Also