IsAnimPlayingEx

From GECK
Jump to: navigation, search


A function added by the JIP NVSE Plugin.

Description

An advanced version of the vanilla function IsAnimPlaying. Unlike the latter, which checks whether the calling reference is currently playing a specific Animation Group, this function allows checking whether any animation group of a certain category, sub-type and variation is playing.

Syntax

[help]
(animPlaying:0/1) reference.IsAnimPlayingEx category:int subType:int variationFlags:int

1st Argument: Animation Categories

1	Miscellaneous
2	Movement
3	Attack
4	Reload
5	Weapon Jam

2nd Argument (Optional): Animation Sub-Types

Miscellaneous:

0	Any
1	Idle
2	(Un-)Equip/Holster
3	Block
4	Handgrip

Movement:

0	Any
1	Forward
2	Backward
3	Left
4	Right
5	Jump

Attack:

0	Any
1	AttackLeft
2	AttackRight
3	Attack3
4	Attack4
5	Attack5
6	Attack6
7	Attack7
8	Attack8
9	Attack9
10	AttackLoop
11	AttackSpin
12	AttackSpin2
13	AttackThrow
14	AttackThrow2
15	AttackThrow3
16	AttackThrow4
17	AttackThrow5
18	AttackThrow6
19	AttackThrow7
20	AttackThrow8
21	PlaceMine
22	PlaceMine2
23	AttackPower

Reload:

N/A

Weapon Jam:

N/A

3rd Argument (Optional): Variation Flags

Miscellaneous:

N/A

Movement:

1	Fast
2	Dodge
4	Turn

Attack:

1	Up
2	Down
4	IS

Reload:

N/A

Weapon Jam:

N/A

Example

set bAnimPlaying to objectRef.IsAnimPlayingEx 2

Returns whether objectRef is playing any Movement animation group.

set bAnimPlaying to objectRef.IsAnimPlayingEx 2 1

Returns whether objectRef is playing a Movement animation group of the Forward sub-type.

set bAnimPlaying to objectRef.IsAnimPlayingEx 3 10

Returns whether objectRef is playing an Attack animation group of the AttackLoop sub-type.

set bAnimPlaying to objectRef.IsAnimPlayingEx 3 0 4

Returns whether objectRef is playing an Attack animation group of any sub-type, and of the IS (iron-sights) variation.

set bAnimPlaying to objectRef.IsAnimPlayingEx 5

Returns whether objectRef is playing any Weapon Jam animation group.