[dismiss]
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"
Jump to navigation
Jump to search
imported>Wrye (→Notes: Generic Unequip) |
imported>Quetzilla |
||
| Line 9: | Line 9: | ||
==Notes== | ==Notes== | ||
'''[[Generic Unequip]]:''' | *'''[[Generic Unequip]]:''' | ||
UnequipItem requires that the base object be specified. For a single script that works for different items, see [[Generic Unequip]]. | UnequipItem requires that the base object be specified. For a single script that works for different items, see [[Generic Unequip]]. | ||
'''Message Spam:''' | *'''Message Spam:''' | ||
By default, using this function on the player will display a message informing the player that the item in question has been unequipped. player. In many situations, this is very annoying, but you can use a pair of blank [[Message]] calls to prevent it from happening, like so: | By default, using this function on the player will display a message informing the player that the item in question has been unequipped. player. In many situations, this is very annoying, but you can use a pair of blank [[Message]] calls to prevent it from happening, like so: | ||
<pre>Message " " | <pre>Message " " | ||
Message " " | Message " " | ||
player.UnequipItem "item ID"</pre> | player.UnequipItem "item ID"</pre> | ||
This seems to shortcircuit the message display and will prevent any other messages from being queued or displayed for a couple of seconds. [[Avoiding Message Spam|Here]] are some alternative methods that don't disrupt other messages. | *This seems to shortcircuit the message display and will prevent any other messages from being queued or displayed for a couple of seconds. [[Avoiding Message Spam|Here]] are some alternative methods that don't disrupt other messages. | ||
*OBSE 0015 provides [[UnequipItemNS]] which works exactly the same as UnequipItem but without displaying any messages. | |||
==See Also== | ==See Also== | ||
*[[UnequipItemNS]] | |||
*[[EquipItem]] | *[[EquipItem]] | ||
*[[Preventing messages]] | *[[Preventing messages]] | ||
Revision as of 20:43, 28 May 2008
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.
Notes
UnequipItem requires that the base object be specified. For a single script that works for different items, see Generic Unequip.
- Message Spam:
By default, using this function on the player will display a message informing the player that the item in question has been unequipped. player. In many situations, this is very annoying, but you can use a pair of blank Message calls to prevent it from happening, like so:
Message " " Message " " player.UnequipItem "item ID"
- This seems to shortcircuit the message display and will prevent any other messages from being queued or displayed for a couple of seconds. Here are some alternative methods that don't disrupt other messages.
- OBSE 0015 provides UnequipItemNS which works exactly the same as UnequipItem but without displaying any messages.