Difference between revisions of "Armor Script"

From the CreationKit Wiki
Jump to navigation Jump to search
imported>CraftySentinel
(→‎SKSE Member Functions: Added Latest SKSE Member Functions.)
imported>CraftySentinel
m (Formatting Change)
Line 24: Line 24:


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


== Member Functions ==
== Member Functions ==
Line 31: Line 39:


== SKSE Member Functions ==
== SKSE Member Functions ==
'''Int Function [[GetArmorRating - Armor|GetArmorRating]]()'''
*Returns the armor rating for this armor.


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


'''Function [[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.
|-


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


'''Function [[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.
|-


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


'''String Function [[GetModelPath - Armor|GetModelPath]](bool bFemalePath)'''
|[[GetModelPath - Armor|String '''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.
|-


'''Function [[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.
|-


'''String Function [[GetIconPath - Armor|GetIconPath]](bool bFemalePath)'''
|[[GetIconPath - Armor|String '''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.
|-


'''Function [[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.
|-


'''String Function [[GetMessageIconPath - Armor|GetMessageIconPath]](bool bFemalePath)'''
|[[GetMessageIconPath - Armor|String '''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.
|-


'''Function [[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.
|-


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


'''Function [[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.
|-


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


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


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


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


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


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


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


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


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


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


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


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


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


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


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


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


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


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


'''Int Function [[AddSlotToMask - Armor|AddSlotToMask]](int slotMask)'''
|[[AddSlotToMask - Armor|Int '''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.
|-


'''Int Function [[RemoveSlotFromMask - Armor|RemoveSlotFromMask]](int slotMask)'''
|[[RemoveSlotFromMask - Armor|Int '''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.
|-


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


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


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


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


|}
== Events ==
== Events ==
None
None

Revision as of 03:47, 24 October 2013


Extends: Form Script (Papyrus)

Script for the manipulation of armor base objects.

Definition

ScriptName Armor extends Form

Properties

None

SKSE Properties

Global Functions

None

SKSE Global Functions

Function Description
Int GetMaskForSlot(Int slot) Returns the slotmask for a single slot.

Member Functions

None

SKSE Member Functions

Function Description
Int GetArmorRating() Returns the armor rating for this armor.
Int GetArmorRating() Alias for GetArmorRating().
SetArmorRating(Int armorRating) Sets the armor rating for this armor to the specified value.
SetArmorRating(Int armorRating) Alias for SetArmorRating().
ModArmorRating(Int modBy) Modifies the armor rating for this armor by the specified amount.
ModArmorRating(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.
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.
Enchantment GetEnchantment() Returns the Enchantment associated with the Armor
SetEnchantment(Enchantment e) Set the Enchantment associated with 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.

Events

None

Retrieved from "https://ck.uesp.net/w/index.php?title=Armor_Script&oldid=6790"