Difference between revisions of "RemoveItem"

Latest revision as of 11:08, 14 April 2009

Removes count number of the specified item from the calling object's inventory.

Syntax:

RemoveItem ObjectID, count

Examples:

RemoveItem Gold001 50

Ref MyItem
Short count

set MyItem to ArenaAkaviriLongSword
set count to 1
player.removeitem MyItem Count

Notes[edit | edit source]

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 reference variable as ObjectID and a 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 Troubleshooting: Common Bugs.

Inventory Updating[edit | edit source]

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

player.AddItem YourMiscItem 1
player.EquipItem YourMiscItem
player.UnEquipItem YourMiscItem
player.RemoveItem YourMiscItem 1

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:

con_ToggleMenus
player.RemoveItem SomeItem001 1
...
player.RemoveItem SomeItem100 1
con_ToggleMenus
;Refresh the menu
player.AddItem YourMiscItem 1
player.EquipItem YourMiscItem
player.UnEquipItem YourMiscItem
player.RemoveItem YourMiscItem 1

@@ Line 1: / Line 1: @@
 Removes ''count'' number of the specified item from the calling object's inventory.
 '''Syntax:'''
   RemoveItem ''ObjectID'', ''count''
 '''Examples:'''
@@ Line 15: / Line 13: @@
   set count to 1
   player.removeitem MyItem Count
 ==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.
-<ul>
+* You can use a [[Variable_types:_reference_variables|reference variable]] as ''ObjectID'' and a [[Variable_types:_shortint|short]] variable for ''count''.
-<li>You can use a [[Variable_types:_reference_variables|reference variable]] as ''ObjectID'' and a [[Variable_types:_shortint|short]] variable for ''count''.</li>
-<li>If ObjectID is a leveled list, the leveled item generated from the leveled list will be removed.</li>
-<li>Removing an equipped item may cause a CTD. Use [[GetEquipped]] to find out if the item is equipped, and, if so, use [[UnequipItem]] before removing it.</li>
+* If ObjectID is a leveled list, the leveled item generated from the leveled list will be removed.
-<li>By default, using this function on the player will display a message informing the player that the item in question has been removed. In many situations, this is very annoying, but you can use a pair of blank [[Message]] calls to prevent it from happening, like so:</li>
+* See [[Message Spam]] for techniques to avoid unwanted "Item Removed" messages.
-<pre>Message " "
-Message " "
-player.RemoveItem "item ID" 1</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.
-<li>OBSE 0015 provides [[RemoveItemNS]] which works exacly the same as RemoveItem but without displaying any messages</li>
+* RemoveItem is not always reliable when removing multiple items at once. See [[Common_Bugs#Remove_Item|Troubleshooting: Common Bugs]].
-<li>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</li>
+==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
 player.EquipItem YourMiscItem
 player.UnEquipItem YourMiscItem
 player.RemoveItem YourMiscItem 1</pre>
-*If the menu has been hidden with '''con_ToggleMenus''' (either via script or console) this will not work.
+However, if the menu has been hidden with '''con_ToggleMenus''' (either via script or console) this will not work.
-<li>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:</li>
+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
 player.RemoveItem SomeItem001 1
@@ Line 52: / Line 44: @@
 player.UnEquipItem YourMiscItem
 player.RemoveItem YourMiscItem 1</pre>
-</ul>
 ==See Also==
-*[[RemoveItemNS]]
+*[[RemoveItemNS]] - Spamless version of command (OBSE 15).
 *[[AddItem]]
 *[[GetItemCount]]
 *[[RemoveAllItems]]
-*[[Preventing messages]]
+*[[Message Spam]] - Preventing message spam.
 [[Category: Functions]]
@@ Line 67: / Line 57: @@
 [[Category: Inventory Functions]]
 [[Category: Inventory Functions (CS 1.0)]]
+<!-- Begin Search Terms
+ Remove
+ Item
+End Search Terms -->

Difference between revisions of "RemoveItem"

Latest revision as of 11:08, 14 April 2009

Notes[edit | edit source]

Inventory Updating[edit | edit source]

See Also[edit | edit source]

Navigation menu

Search