Editing WornObject Script

__NOTOC__ __NOEDITSECTION__

Script for the manipulation of Worn Objects.


== Definition ==
<syntaxhighlight lang="papyrus">
ScriptName WornObject
</syntaxhighlight>


== SKSE Global Functions ==

:'''Float [[GetItemHealthPercent - WornObject|GetItemHealthPercent]](Actor ''akActor'', Int ''handSlot'', Int ''slotMask'')'''
:*Returns the item's tempering.

:'''[[SetItemHealthPercent - WornObject|SetItemHealthPercent]](Actor ''akActor'', Int ''handSlot'', Int ''slotMask'', Float ''health'')'''
:*Sets the item's tempering

:'''[[SetItemMaxCharge - WornObject|SetItemMaxCharge]](Actor ''akActor'', Int ''handSlot'', Int ''slotMask'', Float ''maxCharge'')'''
:*Sets the maximum charge of the worn object.(Only works on player enchants)

:'''Float [[GetItemMaxCharge - WornObject|GetItemMaxCharge]](Actor ''akActor'', Int ''handSlot'', Int ''slotMask'')'''
:*Returns the worn objects max charge.

:'''Float [[GetItemCharge - WornObject|GetItemCharge]](Actor ''akActor'', Int ''handSlot'', Int ''slotMask'')'''
:*Returns the current charge of the worn object.

:'''String [[GetDisplayName - WornObject|GetDisplayName]](Actor ''akActor'', Int ''handSlot'', Int ''slotMask'')'''
:*Returns the name of the worn object (This is the name that is displayed)

:'''Bool [[SetDisplayName- WornObject|SetDisplayName]](Actor ''akActor'', Int ''handSlot'', Int ''slotMask'', String ''name'', Bool ''forced'')'''
:*Sets the display name of the worn object.

:'''Enchantment [[GetEnchantment - WornObject|GetEnchantment]](Actor ''akActor'', Int ''handSlot'', Int ''slotMask'')'''
:*Returns the player-made enchantment if there is one

:'''[[SetEnchantment - WornObject|SetEnchantment]](Actor ''akActor'', Int ''handSlot'', Int ''slotMask'', Enchantment ''source'', Float ''maxCharge'')'''
:*Changes an item's player-made enchantment to the specified Enchant and max charge.

:'''[[CreateEnchantment - WornObject|CreateEnchantment]](Actor ''akActor'', Int ''handSlot'', Int ''slotMask'', Float ''maxCharge'', MagicEffect[] ''effects'', Float[] ''magnitudes'', Int[] ''areas'', Int[] ''durations'')'''
:*Creates a new Enchantment on the worn object with the specified parameters.

:'''Int [[GetNumReferenceAliases - WornObject|GetNumReferenceAliases]](Actor ''akActor'', Int ''handSlot'', Int ''slotMask'')'''
:*Returns the number of reference aliases holding this worn object.

:'''ReferenceAlias [[GetNthReferenceAlias - WornObject|GetNthReferenceAlias]](Actor ''akActor'', Int ''handSlot'', Int ''slotMask'', Int ''n'')'''
:*Returns the nth Reference alias holding this worn object.

:'''Potion [[GetPoison - WornObject|GetPoison]](Actor ''akActor'', Int ''handSlot'', Int ''slotMask'')'''
:*Returns the poison on the specified item

:'''ReferenceAlias[] [[GetReferenceAliases - WornObject|GetReferenceAliases]](Actor ''akActor'', int ''handSlot'', int ''slotMask'')'''
:*Returns all of the ReferenceAlias holding this reference

== Notes ==

*These functions operate directly on worn/equipped items within the inventory. Valid values for ''handSlot'' are 0 (for left hand) or 1 (for right hand). Valid Slot Masks can be found [[Slot_Masks_-_Armor|here]]. Use slotMask of 0 for weapons.

[[Category:Scripting]]
[[Category:Papyrus]]
[[Category:Script Objects]]
[[Category:SKSE]]
[[Category:SKSE Script Objects]]