GetSlotMask - Armor

From the CreationKit Wiki
Revision as of 10:18, 24 September 2014 by imported>Terra Nova2 (→‎Examples: typo..)
Jump to navigation Jump to search

SKSE Member of: Armor Script

Returns the slot mask of the armor. (This function requires SKSE)

Syntax

int Function GetSlotMask() native

Parameters

  • None

Return Value

The slot mask of the armor.

Examples

; Obtain the slot mask of an armor property
int SlotMask = ArmorProperty.GetSlotMask()
if (SlotMask == 4)
	Debug.Trace("This armor is equipped on the body, and only the body.")
endif

; Check if a piece of armor covers more than one slot.
int ThisSlot = (Game.GetPlayer().GetWornForm(0x00000004) as Armor).GetSlotMask()

if ThisSlot == 4 || ThisSlot == 10 || ThisSlot == 100
	debug.notification("True.")
else
	debug.notification("false.")
endif
	
EndFunction
; Results from test returned true. Object used: Forsworm Armor (ID: 000D8D50)

See Also