GetCrippledLimbsAsBitMask

From GECK
Jump to: navigation, search


A function added by the ShowOff NVSE Plugin.

Description

Returns a bitmask detailing an actor's currently crippled limbs.

The "isCrippled" check is performed by checking if the Actor Value for that limb's condition is at or below 0. The minimum amount of health for a limb to be considered "crippled" by this function can be modified by changing healthThreshold.

Syntax

[help]
(crippledLimbsMask:int) ActorRefr.GetCrippledLimbsAsBitMask healthThreshold:int

Example

if Player.GetCrippledLimbsAsBitMask == 3

Checks if the player has both their head and their torso crippled or not.

Notes

  • The limb flags and corresponding numbers are:
Crippled Limb Flag Value
Head 1
Torso 2
Left Arm 4
Right Arm 8
Left Leg 16
Right Leg 32
Brain 64

See Also