Difference between revisions of "Armor Script"

From the CreationKit Wiki
Jump to navigation Jump to search
imported>CraftySentinel
m (→‎SKSE Member Functions: Removed Function Placed in wrong section.)
imported>CraftySentinel
(Reverted Table to List)
Line 1: Line 1:
[[Category:Scripting]]
'''Extends:''' [[Form Script]]
[[Category:Papyrus]]
[[Category:Script Objects]]
[[Category:SKSE]]
[[Category:SKSE Script Objects]]
 
'''Extends:''' [[Form Script (Papyrus)]]


Script for the manipulation of armor base objects.
Script for the manipulation of armor base objects.
Line 14: Line 8:
</source>
</source>


== Properties ==
None


== SKSE Properties ==
== SKSE Properties ==
*[[Slot Masks - Armor|List of Slot Masks]]
*[[Slot Masks - Armor|List of Slot Masks]]


== Global Functions ==
None


== SKSE Global Functions ==
== SKSE Global Functions ==


{|class="wikitable" width =100%
:'''Int [[GetMaskForSlot - Armor|GetMaskForSlot]](Int ''slot'')'''
!style="text-align:left;"|Function
:*Returns the slotmask for a single slot.
!style="text-align:left;"|Description
|-
|[[GetMaskForSlot - Armor|Int '''GetMaskForSlot'''(Int ''slot'')]]
|Returns the slotmask for a single slot.
|-
 
|}


== Member Functions ==
None


== SKSE Member Functions ==
== SKSE Member Functions ==


{|class="wikitable" width =100%
:'''Int [[GetArmorRating - Armor|GetArmorRating]]()'''
!style="text-align:left;"|Function
:*Returns the armor rating for this armor.
!style="text-align:left;"|Description
|-
|[[GetArmorRating - Armor|Int '''GetArmorRating'''()]]
|Returns the armor rating for this armor.
|-


|[[GetArmorRating - Armor|Int '''GetAR'''()]]
:'''Int [[GetArmorRating - Armor|GetAR]]()'''
|Alias for GetArmorRating().
:*Alias for GetArmorRating().
|-


|[[SetArmorRating - Armor|'''SetArmorRating'''(Int ''armorRating'')]]
:'''[[SetArmorRating - Armor|SetArmorRating]](Int ''armorRating'')'''
|Sets the armor rating for this armor to the specified value.
:*Sets the armor rating for this armor to the specified value.
|-


|[[SetArmorRating - Armor|'''SetAR'''(Int ''armorRating'')]]
:'''[[SetArmorRating - Armor|SetAR]](Int ''armorRating'')'''
|Alias for SetArmorRating().
:*Alias for SetArmorRating().
|-


|[[ModArmorRating - Armor|'''ModArmorRating'''(Int ''modBy'')]]
:'''[[ModArmorRating - Armor|ModArmorRating]](Int ''modBy'')'''
|Modifies the armor rating for this armor by the specified amount.
:*Modifies the armor rating for this armor by the specified amount.
|-


|[[ModArmorRating - Armor|'''ModAR'''(Int ''modBy'')]]
:'''[[ModArmorRating - Armor|ModAR]](Int ''modBy'')'''
|Alias for ModArmorRating().
:*Alias for ModArmorRating().
|-


|[[GetModelPath - Armor|String '''GetModelPath'''(Bool ''bFemalePath'')]]
:'''String [[GetModelPath - Armor|GetModelPath]](Bool ''bFemalePath'')'''
|Returns the file path for the nif file representing the world model of the armor.
:*Returns the file path for the nif file representing the world model of the armor.
|-


|[[SetModelPath - Armor|'''SetModelPath'''(String ''path'', Bool ''bFemalePath'')]]
:'''[[SetModelPath - 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.
:*Sets the file path for the nif file representing the world model of the armor to the specified path.
|-


|[[GetIconPath - Armor|String '''GetIconPath'''(Bool ''bFemalePath'')]]
:'''String [[GetIconPath - Armor|GetIconPath]](Bool ''bFemalePath'')'''
|Returns the file path for the nif file representing the icon for the armor in the inventory.
:*Returns the file path for the nif file representing the icon for the armor in the inventory.
|-


|[[SetIconPath - Armor|'''SetIconPath'''(String ''path'', Bool ''bFemalePath'')]]
:'''[[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.
:*Sets the file path for the nif file representing the icon for the armor in the inventory to the specified path.
|-


|[[GetMessageIconPath - Armor|String '''GetMessageIconPath'''(Bool ''bFemalePath'')]]
:'''String [[GetMessageIconPath - Armor|GetMessageIconPath]](Bool ''bFemalePath'')'''
|Returns the file path for the nif file representing the message icon for the armor.
:*Returns the file path for the nif file representing the message icon for the armor.
|-


|[[SetMessageIconPath - Armor|'''SetMessageIconPath'''(String ''path'', Bool ''bFemalePath'')]]
:'''[[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.
:*Sets the file path for the nif file representing the message icon for the armor to the specified path.
|-


|[[GetWeightClass - Armor|Int '''GetWeightClass'''()]]
:'''Int [[GetWeightClass - Armor|GetWeightClass]]()'''
|Returns the weight class of the armor.
:*Returns the weight class of the armor.
|-


|[[SetWeightClass - Armor|'''SetWeightClass'''(Int ''weightClass'')]]
:'''[[SetWeightClass - Armor|SetWeightClass]](Int ''weightClass'')'''
|Sets the weight class of the armor to the specified weight class.
:*Sets the weight class of the armor to the specified weight class.
|-


|[[GetEnchantment - Armor|Enchantment '''GetEnchantment'''()]]
:'''Enchantment [[GetEnchantment - Armor|GetEnchantment]]()'''
|Returns the Enchantment associated with the Armor
:*Returns the Enchantment associated with the Armor
|-


|[[SetEnchantment - Armor|'''SetEnchantment'''(Enchantment ''e'')]]
:'''[[SetEnchantment - Armor|SetEnchantment]](Enchantment ''e'')'''
|Set the Enchantment associated with the Armor
:*Set the Enchantment associated with the Armor
|-


|[[IsLightArmor - Armor|Bool '''IsLightArmor'''()]]
:'''Bool [[IsLightArmor - Armor|IsLightArmor]]()'''
|Is this light armor?
:*Is this light armor?
|-


|[[IsHeavyArmor - Armor|Bool '''IsHeavyArmor'''()]]
:'''Bool [[IsHeavyArmor - Armor|IsHeavyArmor]]()'''
|Is this heavy armor?
:*Is this heavy armor?
|-


|[[IsClothing - Armor|Bool '''IsClothing'''()]]
:'''Bool [[IsClothing - Armor|IsClothing]]()'''
|Is this clothing?
:*Is this clothing?
|-


|[[IsBoots - Armor|Bool '''IsBoots'''()]]
:'''Bool [[IsBoots - Armor|IsBoots]]()'''
|Are these boots?
:*Are these boots?
|-


|[[IsCuirass - Armor|Bool '''IsCuirass'''()]]
:'''Bool [[IsCuirass - Armor|IsCuirass]]()'''
|Is this a cuirass?
:*Is this a cuirass?
|-


|[[IsGauntlets - Armor|Bool '''IsGauntlets'''()]]
:'''Bool [[IsGauntlets - Armor|IsGauntlets]]()'''
|Are these gauntlets?
:*Are these gauntlets?
|-


|[[IsHelmet - Armor|Bool '''IsHelmet'''()]]
:'''Bool [[IsHelmet - Armor|IsHelmet]]()'''
|Is this a helmet?
:*Is this a helmet?
|-


|[[IsShield - Armor|Bool '''IsShield'''()]]
:'''Bool [[IsShield - Armor|IsShield]]()'''
|Is this a shield?
:*Is this a shield?
|-


|[[IsJewelry - Armor|Bool '''IsJewelry'''()]]
:'''Bool [[IsJewelry - Armor|IsJewelry]]()'''
|Is this a piece of jewelry?
:*Is this a piece of jewelry?
|-


|[[IsClothingHead - Armor|Bool '''IsClothingHead'''()]]
:'''Bool [[IsClothingHead - Armor|IsClothingHead]]()'''
|Is this a hat/circlet?
:*Is this a hat/circlet?
|-


|[[IsClothingBody - Armor|Bool '''IsClothingBody'''()]]
:'''Bool [[IsClothingBody - Armor|IsClothingBody]]()'''
|Is this a shirt/pants/dress?
:*Is this a shirt/pants/dress?
|-


|[[IsClothingFeet - Armor|Bool '''IsClothingFeet'''()]]
:'''Bool [[IsClothingFeet - Armor|IsClothingFeet]]()'''
|Are these shoes?
:*Are these shoes?
|-


|[[IsClothingHands - Armor|Bool '''IsClothingHands'''()]]
:'''Bool [[IsClothingHands - Armor|IsClothingHands]]()'''
|Are these gloves?
:*Are these gloves?
|-


|[[IsClothingRing - Armor|Bool '''IsClothingRing'''()]]
:'''Bool [[IsClothingRing - Armor|IsClothingRing]]()'''
|Is this a ring?
:*Is this a ring?
|-


|[[IsClothingRich - Armor|Bool '''IsClothingRich'''()]]
:'''Bool [[IsClothingRich - Armor|'IsClothingRich]]()'''
|Is this rich clothing?
:*Is this rich clothing?
|-


|[[IsClothingPoor - Armor|Bool '''IsClothingPoor'''()]]
:'''Bool [[IsClothingPoor - Armor|IsClothingPoor]]()'''
|Is this poor clothing?
:*Is this poor clothing?
|-


|[[GetSlotMask - Armor|Int '''GetSlotMask'''()]]
:'''Int [[GetSlotMask - Armor|GetSlotMask]]()'''
|Returns the slot mask for the armor.
:*Returns the slot mask for the armor.
|-


|[[SetSlotMask - Armor|'''SetSlotMask'''(Int ''slotMask'')]]
:'''[[SetSlotMask - Armor|SetSlotMask]](Int ''slotMask'')'''
|Sets the slot mask for the armor.
:*Sets the slot mask for the armor.
|-


|[[AddSlotToMask - Armor|Int '''AddSlotToMask'''(Int ''slotMask'')]]
:'''Int [[AddSlotToMask - Armor|AddSlotToMask]](Int ''slotMask'')'''
|Adds the specified slotmask to the armor and returns the new slot mask for the armor.
:*Adds the specified slotmask to the armor and returns the new slot mask for the armor.
|-


|[[RemoveSlotFromMask - Armor|Int '''RemoveSlotFromMask'''(Int ''slotMask'')]]
:'''Int [[RemoveSlotFromMask - Armor|RemoveSlotFromMask]](Int ''slotMask'')'''
|Removes the specified slotmask from the armor and returns the new slot mask for the armor.
:*Removes the specified slotmask from the armor and returns the new slot mask for the armor.
|-


|[[GetNumArmorAddons - Armor|Int '''GetNumArmorAddons'''()]]
:'''Int [[GetNumArmorAddons - Armor|GetNumArmorAddons]]()'''
|Returns the number of armor addons for this armor.
:*Returns the number of armor addons for this armor.
|-


|[[GetNthArmorAddon - Armor|ArmorAddon '''GetNthArmorAddon'''(Int ''n'')]]
:'''ArmorAddon [[GetNthArmorAddon - Armor|GetNthArmorAddon]](Int ''n'')'''
|Returns the nth armor addon for this armor.
:*Returns the nth armor addon for this armor.
|-


|}


== Events ==
[[Category:Scripting]]
None
[[Category:Papyrus]]
[[Category:Script Objects]]
[[Category:SKSE]]
[[Category:SKSE Script Objects]]

Revision as of 05:39, 2 February 2014

Extends: Form Script

Script for the manipulation of armor base objects.

Definition

ScriptName Armor extends Form


SKSE Properties


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.
Retrieved from "https://ck.uesp.net/w/index.php?title=Armor_Script&oldid=6795"