This wiki is a copy of the original Oblivion CS wiki created and maintained by the UESP.net. See CSwiki:Copy Notice for more info.

Difference between revisions of "UnequipItem"

From the Oblivion ConstructionSet Wiki
Jump to navigation Jump to search
imported>DragoonWraith
m (oops, this one is UNequip...)
imported>DragoonWraith
(note about the EquipItem flag)
 
(10 intermediate revisions by 6 users not shown)
Line 4: Line 4:
  UnequipItem FavoriteCuirass
  UnequipItem FavoriteCuirass
  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.


==Notes==
== Note ==


*By default, using this function on the player will display a message informing the player that the item in question has been unequipped. In almost all situations, this is very annoying, but you can use a blank [[Message]] call to prevent it from happening, like so:
* 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.
<pre>Message ""
player.UnequipItem "item ID"</pre>


==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:Actor Functions]]
[[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 -->

Latest revision as of 21:59, 14 February 2009

Syntax:

UnequipItem ObjectID NoEquipFlag

Example:

UnequipItem FavoriteCuirass
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.

Note[edit | edit source]

  • 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[edit | edit source]