Armor Script

Extends: Form Script (Papyrus)

Script for the manipulation of armor base objects.

Definition

ScriptName Armor extends Form

Properties

None

SKSE Properties

• List of Slot Masks

Note: Might be broken. Tests with only "Iron Armor" (Biped Object 32 in CK) equipped returned "Forms" for maskslots 30,31,35... instead of just 32.

Global Functions

None

SKSE Global Functions

Int Function GetMaskForSlot(int slot)

• Returns the slotmask for a single slot.

Member Functions

None

SKSE Member Functions

Int Function GetArmorRating()

• Returns the armor rating for this armor.

Int Function GetAR()

• Alias for GetArmorRating().

Function SetArmorRating(int armorRating)

• Sets the armor rating for this armor to the specified value.

Function SetAR(int armorRating)

• Alias for SetArmorRating().

Function ModArmorRating(int modBy)

• Modifies the armor rating for this armor by the specified amount.

Function ModAR(int modBy)

• Alias for ModArmorRating().

String Function GetModelPath(bool bFemalePath)

• Returns the file path for the nif file representing the world model of the armor.

Function SetModelPath(string path, bool bFemalePath)

• Sets the file path for the nif file representing the world model of the armor to the specified path.

String Function GetIconPath(bool bFemalePath)

• Returns the file path for the nif file representing the icon for the armor in the inventory.

Function SetIconPath(string path, bool bFemalePath)

• Sets the file path for the nif file representing the icon for the armor in the inventory to the specified path.

String Function GetMessageIconPath(bool bFemalePath)

• Returns the file path for the nif file representing the message icon for the armor.

Function SetMessageIconPath(string path, bool bFemalePath)

• Sets the file path for the nif file representing the message icon for the armor to the specified path.

Int Function GetWeightClass()

• Returns the weight class of the armor.

Function SetWeightClass(int weightClass)

• Sets the weight class of the armor to the specified weight class.

Bool Function IsLightArmor()

• Is this light armor?

Bool Function IsHeavyArmor()

• Is this heavy armor?

Bool Function IsClothing()

• Is this clothing?

Bool Function IsBoots()

• Are these boots?

Bool Function IsCuirass()

• Is this a cuirass?

Bool Function IsGauntlets()

• Are these gauntlets?

Bool Function IsHelmet()

• Is this a helmet?

Bool Function IsShield()

• Is this a shield?

Bool Function IsJewelry()

• Is this a piece of jewelry?

Bool Function IsClothingHead()

• Is this a hat/circlet?

Bool Function IsClothingBody()

• Is this a shirt/pants/dress?

Bool Function IsClothingFeet()

• Are these shoes?

Bool Function IsClothingHands()

• Are these gloves?

Bool Function IsClothingRing()

• Is this a ring?

Bool Function IsClothingRich()

• Is this rich clothing?

Bool Function IsClothingPoor()

• Is this poor clothing?

Int Function GetSlotMask()

• Returns the slot mask for the armor.

Function SetSlotMask(int slotMask)

• Sets the slot mask for the armor.

Int Function AddSlotToMask(int slotMask)

• Adds the specified slotmask to the armor and returns the new slot mask for the armor.

Int Function RemoveSlotFromMask(int slotMask)

• Removes the specified slotmask from the armor and returns the new slot mask for the armor.

Events

None