User Tools

Site Tools


give_item

Give Item


Gives one or more of the specified item to the player. The ID of the item is case-sensitive and should match the name assigned to it in the Item Editor. The item(s) will be placed into the first open slot(s) of the player's inventory.

Signature:

give_item(item_id, count, character)
ArgumentDescriptionTypeRequired
item_idID of the item (as defined in the Item Editor).StringYes
countHow many of the item to give to the player (defaults to 1).NumberNo
characterCharacter the item will be given to (defaults to main player character).EntityNo
Return ValueDescriptionType
Number GivenReturns the actual number of items that were given to the player. This could be less than the count supplied to the function, for example if the player's inventory becomes full.Number

Example:

give_item("ITEM_0007", 5);

Results: Five of ITEM_0007 are placed into the player's inventory.

Use the Give Item function to reward the player for completing a quest or as a way of collecting items from treasure chests and other containers.


Editor Node:

Visual Demo:

give_item.txt · Last modified: 2023/04/26 12:22 by justin