Difference between revisions of "UnequipItem"

797 bytes added ,  21:59, 14 February 2009
note about the EquipItem flag
imported>Diablerie
(Does not trigger OnUnequip)
imported>DragoonWraith
(note about the EquipItem flag)
 
(14 intermediate revisions by 8 users not shown)
Line 5: Line 5:
  player.UnequipItem AmuletOfKings 1
  player.UnequipItem AmuletOfKings 1


Forces the actor to unequip the object. If NoEquipFlag = 1, actor (including the player) will be unable to equip the object.


Forces the actor to unequip the object. If NoEquipFlag = 1, actor (including the player) will be unable to equip the object.
== Note ==


Note: This command does not trigger a "Begin OnUnequip" block on the item.
* UnequipItem (and [[UnequipItemNS]]) are the only ways to remove items that have been equipped with [[EquipItem]] with its "no-unequip" flag set to 1. To check for this flag before calling UnequipItem (to avoid unequipping items that you shouldn't), try using EquipItem ''without the flag'' on another item that uses the same slot. If the flag has been set on the currently equipped item, the script will be unable to equip a new item over it.


==See Also==
== See Also ==
[[EquipItem]]


*[[UnequipItemNS]] - Spamless version of command (OBSE 15)
*[[EquipItem]]
*[[Message Spam]] - Avoiding message spam.
*[[Generic Unequip]] - Unequipping an item knowing its editor id.


[[Category: Functions]]
[[Category: Functions]]
[[Category: Object Functions]]
[[Category:Functions (CS)]]
[[Category: Functions (CS 1.0)]]
[[Category: Actor Functions]]
[[Category: Actor Functions (CS 1.0)]]
[[Category: Inventory Functions]]
[[Category: Inventory Functions (CS 1.0)]]
 
<!-- Begin Search Terms
Unequip
equip
item
End Search Terms -->