GetAnimAction

Revision as of 09:26, 27 March 2009 by imported>Henning (Added a note on a specific return code which might not correspond to the one listed.)
< [[::Category:Functions|Category:Functions]]

A function included in the GECK version 1.1.0.36.

Description

GetAnimAction is a script function and condition to see what special animation action an actor is currently doing.

Syntax

(actionIndex:int) Actor.GetAnimAction

Example

if BuddyRef.GetAnimAction == 8

Determines if Buddy is performing the reload animation.

Notes

The return codes listed here are wrong in some cases
Further information might be found in a section of the discussion page. Please remove this message when no longer necessary.
  • Return Values:
    • -1 - none
    • 0 - ANIM_ACTION_EQUIP_WEAPON
    • 1 - ANIM_ACTION_UNEQUIP_WEAPON
    • 2 - ANIM_ACTION_ATTACK
    • 3 - ANIM_ACTION_ATTACK_FOLLOW_THROUGH
    • 4 - ANIM_ACTION_ATTACK_THROW
    • 5 - ANIM_ACTION_ATTACK_THROW_ATTACH
    • 6 - ANIM_ACTION_BLOCK
    • 7 - ANIM_ACTION_RECOIL
    • 8 - ANIM_ACTION_RELOAD
    • 9 - ANIM_ACTION_STAGGER
    • 10 - ANIM_ACTION_DODGE
    • 11 - ANIM_ACTION_WAIT_FOR_LOWER_BODY_ANIM
    • 12 - ANIM_ACTION_WAIT_FOR_SPECIAL_IDLE
    • 13 - ANIM_ACTION_FORCE_SCRIPT_ANIM

Note: When the player is blocking whether with a melee weapon or unarmed, the return value is 7 not 6. This is also the return value when the player is "zooming" (the normal behavior of the right-button click) with pistols for instance.