Background for Skyrim SE

iEquip_InventoryExt


Inheritance Tree

No indexed scripts extend this script.

Properties

iequip

intinvalid_refhandle=0xffff
Events
Functions
voidfunctionRegisterForOnRefHandleActiveEvent(Forma_thisForm)NativeGlobal

@brief Registers the passed script to be notified when a ref handle becomes active.
@param a_thisForm The form to register for the event (i.e. Self).

voidfunctionUnregisterForOnRefHandleActiveEvent(Forma_thisForm)NativeGlobal

@brief Unregisters the passed script to no longer be notified when a ref handle becomes active.
@param a_thisForm The form to register for the event (i.e. Self).

voidfunctionRegisterForOnRefHandleInvalidatedEvent(Forma_thisForm)NativeGlobal

@brief Registers the passed script to be notified when a ref handle becomes invalidated.
@param a_thisForm The form to register for the event (i.e. Self).

voidfunctionUnregisterForOnRefHandleInvalidatedEvent(Forma_thisForm)NativeGlobal

@brief Unregisters the passed script to no longer be notified when a ref handle becomes invalidated.
@param a_thisForm The form to register for the event (i.e. Self).

voidfunctionEquipItem(Forma_item, inta_refHandle, Actora_actor, inta_equipSlot=0, boola_preventUnequip=false, boola_equipSound=true)NativeGlobal

[DEV SERVER] Loading description...

EnchantmentfunctionGetEnchantment(Forma_item, inta_refHandle)NativeGlobal

@brief Retrieves the enchantment on the item.
@param a_item The item to retrieve the enchantment of.
@param a_refHandle The handle to the item.
@return Returns NONE error, else returns the enchantment.

stringfunctionGetLongName(Forma_item, inta_refHandle)NativeGlobal

@brief Retrieves the full display name of the item.
@param a_item The item to retrieve the full display name of.
@param a_refHandle The handle to the item.
@return Returns "" error, else returns the full display name.

PotionfunctionGetPoison(Forma_item, inta_refHandle)NativeGlobal

@brief Retrieves the poison applied to the item.
@param a_item The item to retrieve the poison from.
@param a_refHandle The handle to the item.
@return Returns NONE error, else returns the applied poison.

intfunctionGetPoisonCount(Forma_item, inta_refHandle)NativeGlobal

@brief Retrieves the poison count of the item.
@param a_item The item to retrieve the poison count of.
@param a_refHandle The handle to the item.
@return Returns 0 error, else returns the poison count.

intfunctionGetRefHandleAtInvIndex(inta_index)NativeGlobal

@brief Retrieves the ref handle from the item at the given inventory index.
@param a_index The inventory index of the item to retrieve the ref handle of.
@return Returns INVALID_REFHANDLE on error, else returns the ref handle for the item.

intfunctionGetRefHandleFromWornObject(inta_equipSlot)NativeGlobal

@brief Retrieves the ref handle from the worn object.
@param a_equipSlot The slot the object is equipped to.
@return Returns INVALID_REFHANDLE on error, else returns the ref handle for the worn object.
@notes Valid equip slots:
0 - LeftHand
1 - RightHand
2 - Shield
3 - Head
4 - Chest
5 - Boots
6 - Gloves

stringfunctionGetShortName(Forma_item, inta_refHandle)NativeGlobal

@brief Retrieves the short display name of the item, without the temper string.
@param a_item The item to retrieve the short display name of.
@param a_refHandle The handle to the item.
@return Returns "" error, else returns the short display name.

voidfunctionParseInventory()NativeGlobal

@brief Parses the player's inventory and assigns ref handles.
Must be run so the player's existing inventory can be tracked.

voidfunctionClearAllRefHandles()NativeGlobal

@brief Clears down all pre-10.x ref handles.
Should be followed by ParseInventory to then assign handles under the new manager.

voidfunctionRemovePoison(Forma_item, inta_refHandle)NativeGlobal

@brief Removes the applied poison from the given item, if any.
@param a_item The item to remove the poison from.
@param a_refHandle The handle to the item.

voidfunctionSetPoison(Forma_item, inta_refHandle, Potiona_newPoison, inta_newCount)NativeGlobal

@brief Applies the given poison to the given item with the given number of charges.
@param a_item The item to apply the poison to.
@param a_refHandle The handle to the item.
@param a_newPoison The new poison to apply.
@param a_newCount The number of charges to apply.

voidfunctionSetPoisonCount(Forma_item, inta_refHandle, inta_newCount)NativeGlobal

@brief Sets the poison count of the item.
@param a_item The item to set the poison count on.
@param a_refHandle The handle to the item.
@param a_newCount The new poison count.
@notes Only works if the weapon has an existing poison applied.

Some data provided by the Skyrim Creation Kit Wiki. Licensed under the Creative Commons Attribution-ShareAlike license.