Differences

This shows you the differences between two versions of the page.

--- remove_item [2017/05/01 14:00] – justin
+++ remove_item [2023/04/26 12:22] (current) – justin
@@ Line 2: / Line 2: @@
 ----
-Removes the specified item from the player's inventory. Only one instance is removed if the player has more than one of the item.
+Removes one or more of the specified [[item]] from the player's [[inventory]]. The ID of the [[item]] is case-sensitive and should match the name assigned to it in the [[Item Editor]].
+====Signature:====
 <code python>
-remove_item(item_name)
+remove_item(item_id, count, *character)
 </code>
 ^Argument^Description^Type^Required^
-|item_name|Name of the item to remove (as defined in the [[Item Editor]])|[[String]]|Yes|
+|item_name|ID of the [[item]] (as defined in the [[Item Editor]]).|[[String]]|Yes|
+|count|How many of the [[item]] to take from the player (defaults to 1).|[[Number]]|No|
+|character|[[Character]] the [[item]] will be taken from (defaults to main [[player character]]).|[[Entity]]|No|
+^Return Value^Description^Type^
+|Number Removed|Returns the actual number of [[item|items]] that were removed from the player's [[inventory]]. This could be less than the count supplied to the function, for example if the player has less than requested.|[[Number]]|
 ====Example:====
-<code python>
+<code bauxite>
-remove_item("Gold Key")
+remove_item("ITEM_0008", 1);
 </code>
-//Results:// A gold key is removed from the player's inventory.
+//Results:// One of ITEM_0008 (a gold key) is removed from the player's [[inventory]].
 <WRAP center round tip 100%>
-Use the **Remove Item** function when turning in a quest item for an NPC or opening a container with a key that's only good for one use.
+Use the **Remove Item** function when turning in a quest [[item]] for an [[NPC]] or opening a [[item_container|container]] with a key that's only good for one use.
 </WRAP>

RPG in a BoxOfficial Documentation

User Tools

Site Tools

Differences

Page Tools

RPG in a Box
Official Documentation