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, *character)

Argument	Description	Type	Required
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 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.

RPG in a Box
Official Documentation

Sidebar

Remove Item

Signature:

Example:

Editor Node:

Visual Demo:

RPG in a BoxOfficial Documentation

User Tools

Site Tools

Sidebar

Remove Item

Signature:

Example:

Editor Node:

Visual Demo:

Page Tools

RPG in a Box
Official Documentation