GiveItem
giveItem
Adds a known item to a player's authoritative inventory.
Syntax
bool giveItem(int playerId, string itemKey [, int quantity = 1])
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
playerId |
int |
yes | The connected player identifier. |
itemKey |
string |
yes | A rune, armor, or melee weapon key from the server catalog. |
quantity |
int |
no | Number of items to add, from 1 to 1000; defaults to 1. |
Returns
Returns true when the inventory change is validated, replicated, and applied by the server; otherwise returns false.
Examples
Give a player one sword and equip it:
if giveItem(playerId, "1h_sword_01") then
setPlayerWeapon(playerId, "1h_sword_01")
end
Notes
- Available only in server-side resource scripts.
- Compatibility alias of
givePlayerItem. - The resulting total may not be negative or exceed 100000 items.