Difference between revisions of "Armor Script"

Armor Script (edit)

Revision as of 11:17, 10 May 2012

3,619 bytes added , 11:17, 10 May 2012

Added SKSE Member Functions

Anonymous user

imported>Fg109

@@ Line 1: / Line 1: @@
-[[Category:Scripting]]
+== SKSE Member Functions ==
-[[Category:Papyrus]]
+'''Int Function [[GetArmorRating - Armor|GetArmorRating]]()'''
-[[Category:Script Objects]]
+*Returns the armor rating for this armor.
-'''Extends:''' [[Form Script (Papyrus)]]
+'''Int Function [[GetArmorRating - Armor|GetAR]]()'''
+*Alias for GetArmorRating().
-Script for the manipulation of armor base objects.
+'''Function [[SetArmorRating - Armor|SetArmorRating]](int armorRating)'''
+*Sets the armor rating for this armor to the specified value.
-== Definition ==
+'''Function [[SetArmorRating - Armor|SetAR]](int armorRating)'''
-<source lang="papyrus">
+*Alias for SetArmorRating().
-ScriptName Armor extends Form
-</source>
-== Properties ==
+'''Function [[ModArmorRating - Armor|ModArmorRating]](int modBy)'''
-None
+*Modifies the armor rating for this armor by the specified amount.
-== Global Functions ==
+'''Function [[ModArmorRating - Armor|ModAR]](int modBy)'''
-None
+*Alias for ModArmorRating().
-== Member Functions ==
+'''String Function [[GetModelPath - Armor|GetModelPath]](bool bFemalePath)'''
-None
+*Returns the file path for the nif file representing the world model of the armor.
-== Events ==
+'''Function [[SetModelPath - Armor|SetModelPath]](string path, bool bFemalePath)'''
-None
+*Sets the file path for the nif file representing the world model of the armor to the specified path.
+'''String Function [[GetIconPath - Armor|GetIconPath]](bool bFemalePath)'''
+*Returns the file path for the nif file representing the icon for the armor in the inventory.
+'''Function [[SetIconPath - Armor|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 - Armor|GetMessageIconPath]](bool bFemalePath)'''
+*Returns the file path for the nif file representing the message icon for the armor.
+'''Function [[SetMessageIconPath - 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 Function [[GetWeightClass - Armor|GetWeightClass]]()'''
+*Returns the weight class of the armor.
+'''Function [[SetWeightClass - Armor|SetWeightClass]](int weightClass)'''
+*Sets the weight class of the armor to the specified weight class.
+'''Bool Function [[IsLightArmor - Armor|IsLightArmor]]()'''
+*Is this light armor?
+'''Bool Function [[IsHeavyArmor - Armor|IsHeavyArmor]]()'''
+*Is this heavy armor?
+'''Bool Function [[IsClothing - Armor|IsClothing]]()'''
+*Is this clothing?
+'''Bool Function [[IsBoots - Armor|IsBoots]]()'''
+*Are these boots?
+'''Bool Function [[IsCuirass - Armor|IsCuirass]]()'''
+*Is this a cuirass?
+'''Bool Function [[IsGauntlets - Armor|IsGauntlets]]()'''
+*Are these gauntlets?
+'''Bool Function [[IsHelmet - Armor|IsHelmet]]()'''
+*Is this a helmet?
+'''Bool Function [[IsShield - Armor|IsShield]]()'''
+*Is this a shield?
+'''Bool Function [[IsJewelry - Armor|IsJewelry]]()'''
+*Is this a piece of jewelry?
+'''Bool Function [[IsClothingHead - Armor|IsClothingHead]]()'''
+*Is this a hat/circlet?
+'''Bool Function [[IsClothingBody - Armor|IsClothingBody]]()'''
+*Is this a shirt/pants/dress?
+'''Bool Function [[IsClothingFeet - Armor|IsClothingFeet]]()'''
+*Are these shoes?
+'''Bool Function [[IsClothingHands - Armor|IsClothingHands]]()'''
+*Are these gloves?
+'''Bool Function [[IsClothingRing - Armor|IsClothingRing]]()'''
+*Is this a ring?
+'''Bool Function [[IsClothingRich - Armor|IsClothingRich]]()'''
+*Is this rich clothing?
+'''Bool Function [[IsClothingPoor - Armor|IsClothingPoor]]()'''
+*Is this poor clothing?
+'''Int Function [[GetSlotMask - Armor|GetSlotMask]]()'''
+*Returns the slot mask for the armor.
+'''Function [[SetSlotMask - Armor|SetSlotMask]](int slotMask)'''
+*Sets the slot mask for the armor.
+'''Int Function [[AddSlotToMask - Armor|AddSlotToMask]](int slotMask)'''
+*Adds the specified slotmask to the armor and returns the new slot mask for the armor.
+'''Int Function [[RemoveSlotFromMask - Armor|RemoveSlotFromMask]](int slotMask)'''
+*Removes the specified slotmask from the armor and returns the new slot mask for the armor.
+'''Int Function [[GetMaskForSlot- Armor|GetMaskForSlot]](int slot)'''
+*Returns the slotmask for a single slot.