User Tools

Site Tools


remove_item

Remove 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:

remove_item(item_id, count)
ArgumentDescriptionTypeRequired
item_nameID of the item (as defined in the Item Editor).StringYes
countHow many of the item to take from the player (defaults to 1).NumberNo
Return ValueDescriptionType
Number RemovedReturns the actual number of 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:

remove_item("ITEM_0008", 1);

Results: One of ITEM_0008 (a gold key) is removed from the player's inventory.

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.


Editor Node:

Visual Demo:

remove_item.txt · Last modified: 2023/01/02 21:07 by justin