Background for Skyrim SE

The Armor Script

    The Armor script is a part of Skyrim SE’s Papyrus scripting ecosystem. It is included with the base game, and is extended/modified by modded sources such as Skyrim Script Extender x64 (SKSE).

    For this script, the Papyrus index knows about:

    • 40 functions
    • 32 properties


    Inheritance Tree

    No indexed scripts extend this script.

    Properties

    • skse

      • intkslotmask30=0x1
      • intkslotmask31=0x2
      • intkslotmask32=0x4
      • intkslotmask33=0x8
      • intkslotmask34=0x10
      • intkslotmask35=0x20
      • intkslotmask36=0x40
      • intkslotmask37=0x80
      • intkslotmask38=0x100
      • intkslotmask39=0x200
      • intkslotmask40=0x400
      • intkslotmask41=0x800
      • intkslotmask42=0x1000
      • intkslotmask43=0x2000
      • intkslotmask44=0x4000
      • intkslotmask45=0x8000
      • intkslotmask46=0x10000
      • intkslotmask47=0x20000
      • intkslotmask48=0x40000
      • intkslotmask49=0x80000
      • intkslotmask50=0x100000
      • intkslotmask51=0x200000
      • intkslotmask52=0x400000
      • intkslotmask53=0x800000
      • intkslotmask54=0x1000000
      • intkslotmask55=0x2000000
      • intkslotmask56=0x4000000
      • intkslotmask57=0x8000000
      • intkslotmask58=0x10000000
      • intkslotmask59=0x20000000
      • intkslotmask60=0x40000000
      • intkslotmask61=0x80000000

      Events

        No events found.

      Functions

      • floatfunctionGetWarmthRating()Native

        Obtains the "warmth rating" of this piece of armor.

      • intfunctionGetArmorRating()Native

        Gets the armor rating of the armor. (This function requires SKSE)

      • intfunctionGetAR()
      • voidfunctionSetArmorRating(intarmorRating)Native

        Sets the armor rating of the armor to the specified value. (This function requires SKSE)

      • voidfunctionSetAR(intarmorRating)
      • voidfunctionModArmorRating(intmodBy)Native

        Modifies the armor rating for this armor by the specified amount. (This function requires SKSE)

      • voidfunctionModAR(intmodBy)
      • stringfunctionGetModelPath(boolbFemalePath)Native

        Returns the file path for the NetImmerse File (.nif) representing the world & inventory model of the armor. (This function requires SKSE)

      • voidfunctionSetModelPath(stringpath, boolbFemalePath)Native

        Sets the file path for the NetImmerse File (.nif) representing the world & inventory model of the armor to the specified path. (This function requires SKSE)

      • stringfunctionGetIconPath(boolbFemalePath)Native

        works on the path to the nif file representing the icon for the weapon in the inventory

      • voidfunctionSetIconPath(stringpath, boolbFemalePath)Native
      • stringfunctionGetMessageIconPath(boolbFemalePath)Native

        works on the path to the file representing the message icon for the weapon

      • voidfunctionSetMessageIconPath(stringpath, boolbFemalePath)Native
      • intfunctionGetWeightClass()Native

        Returns the weight class of the armor. (This function requires SKSE)

      • voidfunctionSetWeightClass(intweightClass)Native

        Sets the weight class of the armor to the specified weight class. (This function requires SKSE)

      • EnchantmentfunctionGetEnchantment()Native

        Returns the Enchantment associated with this armor. Note refers to the base object, not an object reference. (This function requires SKSE)

      • voidfunctionSetEnchantment(Enchantmente)Native

        Sets the Enchantment associated with this armor. Note refers to the base object, not an object reference. (This function requires SKSE)

      • boolfunctionIsLightArmor()

        Checks if the armor has the ArmorLight keyword. (This function requires SKSE)

      • boolfunctionIsHeavyArmor()

        Checks if the armor has the ArmorHeavy keyword. (This function requires SKSE)

      • boolfunctionIsClothing()

        Checks if the armor has the ArmorClothing keyword. (This function requires SKSE)

      • boolfunctionIsBoots()

        Checks if the armor has the ArmorBoots keyword. (This function requires SKSE)

      • boolfunctionIsCuirass()

        Checks if the armor has the ArmorCuirass keyword. (This function requires SKSE)

      • boolfunctionIsGauntlets()

        Checks if the armor has the ArmorGauntlets keyword. (This function requires SKSE)

      • boolfunctionIsHelmet()

        Checks if the armor has the ArmorHelmet keyword. (This function requires SKSE)

      • boolfunctionIsShield()

        Checks if the armor has the ArmorShield keyword. (This function requires SKSE)

      • boolfunctionIsJewelry()

        Checks if the armor has the ArmorJewelry keyword. (This function requires SKSE)

      • boolfunctionIsClothingHead()

        Checks if the armor has the ClothingHead keyword. (This function requires SKSE)

      • boolfunctionIsClothingBody()

        Checks if the armor has the ClothingBody keyword. (This function requires SKSE)

      • boolfunctionIsClothingFeet()

        Checks if the armor has the ClothingFeet keyword. (This function requires SKSE)

      • boolfunctionIsClothingHands()

        Checks if the armor has the ClothingHands keyword. (This function requires SKSE)

      • boolfunctionIsClothingRing()

        Checks if the armor has the ClothingRing keyword. (This function requires SKSE)

      • boolfunctionIsClothingRich()

        Checks if the armor has the ClothingRich keyword. (This function requires SKSE)

      • boolfunctionIsClothingPoor()

        Checks if the armor has the ClothingPoor keyword. (This function requires SKSE)

      • intfunctionGetSlotMask()Native

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

      • voidfunctionSetSlotMask(intslotMask)Native

        Sets the slot mask for the armor. (This function requires SKSE)

      • intfunctionAddSlotToMask(intslotMask)Native

        Adds the specified slot mask to the armor and returns the new slot mask for the armor. (This function requires SKSE)

      • intfunctionRemoveSlotFromMask(intslotMask)Native

        Removes the specified slot mask from the armor and returns the new slot mask for the armor. (This function requires SKSE)

      • intfunctionGetMaskForSlot(intslot)NativeGlobal

        Returns the slot mask for a single slot. (This function requires SKSE)

      • intfunctionGetNumArmorAddons()Native

        returns the number of armor addons for this armor

      • ArmorAddonfunctionGetNthArmorAddon(intn)Native

        Returns the nth ArmorAddon object associated with this armor. (This function requires SKSE)

      Some data provided by the Skyrim Creation Kit Wiki. Licensed under the Creative Commons Attribution-ShareAlike license.