UnequipItemEx - Actor

From the CreationKit Wiki
Revision as of 21:12, 27 February 2013 by imported>Wafflesalot (Created page with "Category:Scripting Category:Papyrus Category:SKSE '''SKSE Member of:''' Actor Script Forces this actor to equip the specified item at the specified slot. == ...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

SKSE Member of: Actor Script

Forces this actor to equip the specified item at the specified slot.

Syntax[edit | edit source]

Function UnequipItemEx(Form item, int equipSlot = 0, bool preventEquip = false) native

Parameters[edit | edit source]

  • item - The Form of the item to equip.
  • equipSlot - The slot of the item you wish to unequip
    • Default Slot = 0
    • Right Hand Slot = 1
    • Left Hand Slot = 2
  • preventEquip - If true, will prevent equipping of the item for the actor.

Examples[edit | edit source]

;Force the player to unequip swordProperty from the Default slot
Game.GetPlayer().UnequipItemEx(swordProperty)


; Force Terion to unequip a Dagger from his Left hand and prevent it being requipped.
Terion.UnequipItemEx(DaggerProperty, 2, True)

Notes[edit | edit source]

  • If the Specified form is not in the specified slot then the function will fail.

See Also[edit | edit source]