Difference between revisions of "RemoveItem"
→Notes: Troubleshooting link
imported>Haama (→Notes: Note on equipped item crashes) |
imported>Dev akm (→Notes: Troubleshooting link) |
||
(5 intermediate revisions by 4 users not shown) | |||
Line 1: | Line 1: | ||
Removes ''count'' number of the specified item from the calling object's inventory. | Removes ''count'' number of the specified item from the calling object's inventory. | ||
'''Syntax:''' | '''Syntax:''' | ||
RemoveItem ''ObjectID'', ''count'' | RemoveItem ''ObjectID'', ''count'' | ||
'''Examples:''' | '''Examples:''' | ||
Line 15: | Line 13: | ||
set count to 1 | set count to 1 | ||
player.removeitem MyItem Count | player.removeitem MyItem Count | ||
==Notes== | ==Notes== | ||
* Suffers from the same stability limitations as [[RemoveMe]]. Using RemoveItem immediately after the object has been added will often result in a crash. To prevent this, wait more than one frame before you remove the item. | |||
* You can use a [[Variable_types:_reference_variables|reference variable]] as ''ObjectID'' and a [[Variable_types:_shortint|short]] variable for ''count''. | |||
* If ObjectID is a leveled list, the leveled item generated from the leveled list will be removed. | |||
* See [[Message Spam]] for techniques to avoid unwanted "Item Removed" messages. | |||
* RemoveItem is not always reliable when removing multiple items at once. See [[Common_Bugs#Remove_Item|Troubleshooting: Common Bugs]]. | |||
==Inventory Updating== | |||
When you remove an item while the player's inventory menu ([[MenuMode]] 1002) is open, the item will remain visible even though it's really not there. To refresh the menu after removing the item, use | |||
<pre>player.AddItem YourMiscItem 1 | <pre>player.AddItem YourMiscItem 1 | ||
player.EquipItem YourMiscItem | player.EquipItem YourMiscItem | ||
player.UnEquipItem YourMiscItem | player.UnEquipItem YourMiscItem | ||
player.RemoveItem YourMiscItem 1</pre> | player.RemoveItem YourMiscItem 1</pre> | ||
However, if the menu has been hidden with '''con_ToggleMenus''' (either via script or console) this will not work. | |||
When you remove a large number of unique items from the player while their inventory menu is open, there may be some lag. You can prevent this with OBSE's [[con_ToggleMenus]] by placing it on both sides of the remove lines: | |||
<pre>con_ToggleMenus | <pre>con_ToggleMenus | ||
player.RemoveItem SomeItem001 1 | player.RemoveItem SomeItem001 1 | ||
Line 50: | Line 44: | ||
player.UnEquipItem YourMiscItem | player.UnEquipItem YourMiscItem | ||
player.RemoveItem YourMiscItem 1</pre> | player.RemoveItem YourMiscItem 1</pre> | ||
==See Also== | ==See Also== | ||
*[[RemoveItemNS]] - Spamless version of command (OBSE 15). | |||
*[[AddItem]] | *[[AddItem]] | ||
*[[GetItemCount]] | *[[GetItemCount]] | ||
*[[RemoveAllItems]] | *[[RemoveAllItems]] | ||
*[[ | *[[Message Spam]] - Preventing message spam. | ||
[[Category: Functions]] | [[Category: Functions]] | ||
Line 64: | Line 57: | ||
[[Category: Inventory Functions]] | [[Category: Inventory Functions]] | ||
[[Category: Inventory Functions (CS 1.0)]] | [[Category: Inventory Functions (CS 1.0)]] | ||
<!-- Begin Search Terms | |||
Remove | |||
Item | |||
End Search Terms --> |