Armor Script

Extends: Form Script

Script for the manipulation of armor base objects.

Definition

ScriptName Armor extends Form

Special Edition Exclusive Functions

Float GetWarmthRating()

• Obtains the total "warmth rating" for the armor

SKSE Properties

• List of Slot Masks

SKSE Global Functions

Int GetMaskForSlot(Int slot)

• Returns the slotmask for a single slot.

SKSE Member Functions

Int GetArmorRating()

• Returns the armor rating for this armor.

Int GetAR()

• Alias for GetArmorRating().

SetArmorRating(Int armorRating)

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

SetAR(Int armorRating)

• Alias for SetArmorRating().

ModArmorRating(Int modBy)

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

ModAR(Int modBy)

• Alias for ModArmorRating().

String GetModelPath(Bool bFemalePath)

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

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 GetIconPath(Bool bFemalePath)

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

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 GetMessageIconPath(Bool bFemalePath)

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

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 GetWeightClass()

• Returns the weight class of the armor.

SetWeightClass(Int weightClass)

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

Enchantment GetEnchantment()

• Returns the Enchantment associated with the Armor

SetEnchantment(Enchantment e)

• Set the Enchantment associated with the Armor

Bool IsLightArmor()

• Is this light armor?

Bool IsHeavyArmor()

• Is this heavy armor?

Bool IsClothing()

• Is this clothing?

Bool IsBoots()

• Are these boots?

Bool IsCuirass()

• Is this a cuirass?

Bool IsGauntlets()

• Are these gauntlets?

Bool IsHelmet()

• Is this a helmet?

Bool IsShield()

• Is this a shield?

Bool IsJewelry()

• Is this a piece of jewelry?

Bool IsClothingHead()

• Is this a hat/circlet?

Bool IsClothingBody()

• Is this a shirt/pants/dress?

Bool IsClothingFeet()

• Are these shoes?

Bool IsClothingHands()

• Are these gloves?

Bool IsClothingRing()

• Is this a ring?

Bool 'IsClothingRich()

• Is this rich clothing?

Bool IsClothingPoor()

• Is this poor clothing?

Int GetSlotMask()

• Returns the slot mask for the armor.

SetSlotMask(Int slotMask)

• Sets the slot mask for the armor.

Int AddSlotToMask(Int slotMask)

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

Int RemoveSlotFromMask(Int slotMask)

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

Int GetNumArmorAddons()

• Returns the number of armor addons for this armor.

ArmorAddon GetNthArmorAddon(Int n)

• Returns the nth armor addon for this armor.