View source for GiveItem

<!-- This page is generated automatically from the function definition: giveItem. -->
= giveItem =
Adds a known item to a player's authoritative inventory.

== Syntax ==
<syntaxhighlight lang="lua">
bool giveItem(int playerId, string itemKey [, int quantity = 1])
</syntaxhighlight>

== Parameters ==
{| class="wikitable"
! Name !! Type !! Required !! Description
|-
| <code>playerId</code> || <code>int</code> || yes || The connected player identifier.
|-
| <code>itemKey</code> || <code>string</code> || yes || A rune, armor, or melee weapon key from the server catalog.
|-
| <code>quantity</code> || <code>int</code> || no || Number of items to add, from 1 to 1000; defaults to 1.
|}

== Returns ==
Returns <code>true</code> when the inventory change is validated, replicated, and applied by the server; otherwise returns <code>false</code>.

== Examples ==
Give a player one sword and equip it:
<syntaxhighlight lang="lua" line>
if giveItem(playerId, "1h_sword_01") then
    setPlayerWeapon(playerId, "1h_sword_01")
end
</syntaxhighlight>

== Notes ==
* Available only in server-side resource scripts.
* Compatibility alias of <code>givePlayerItem</code>.
* The resulting total may not be negative or exceed 100000 items.

[[Category:Lua Functions]]
[[Category:Server Functions]]
[[Category:Player Functions]]
[[Category:Inventory Functions]]