WornObject Script

From the CreationKit Wiki
Revision as of 04:14, 3 February 2014 by imported>CraftySentinel (Added some bland descriptions, fixed more typos)
Jump to navigation Jump to search


Script for the manipulation of Worn Objects.


Definition

ScriptName WornObject


SKSE Global Functions

Float GetItemHealthPercent(Actor akActor, Int handSlot, Int slotMask)
  • Returns the item's tempering.
SetItemHealthPercent(Actor akActor, Int handSlot, Int slotMask, Float health)
  • Sets the item's tempering
SetItemMaxCharge(Actor akActor, Int handSlot, Int slotMask, Float maxCharge)
  • Sets the maximum charge of the worn object.(Only works on player enchants)
Float GetItemMaxCharge(Actor akActor, Int handSlot, Int slotMask)
  • Returns the worn objects max charge.
Float GetItemCharge(Actor akActor, Int handSlot, Int slotMask)
  • Returns the current charge of the worn object.
String GetDisplayName(Actor akActor, Int handSlot, Int slotMask)
  • Returns the name of the worn object (This is the name that is displayed)
Bool SetDisplayName(Actor akActor, Int handSlot, Int slotMask, String name, Bool forced)
  • Sets the display name of the worn object.
'Enchantment GetEnchantment(Actor akActor, Int handSlot, Int slotMask)
  • Returns the player-made enchantment if there is one
SetItemMaxCharge(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(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(Actor akActor, Int handSlot, Int slotMask)
  • Returns the number of reference aliases holding this worn object.
ReferenceAlias GetNthReferenceAlias(Actor akActor, Int handSlot, Int slotMask, Int n)
  • Returns the nth Reference alias holding this worn object.