GetPlayerItemCount

From Wiki G1R-MP G1 Remake Multiplayer
Revision as of 18:40, 3 September 2026 by QCherry (talk | contribs) (Document Lua APIs available or improved from G1R:MP 0.1.2)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

getPlayerItemCount

IMPROVED FROM UPDATE 0.1.2
This function is available in earlier releases and has corrected or expanded behavior in G1R:MP 0.1.2 and later. The contract below describes the updated behavior.

Returns the quantity of a known inventory item in the player's authoritative server runtime cache.

Syntax

int|false getPlayerItemCount(int playerId, string itemKey)

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.

Returns

Returns the item quantity, including 0 when the player owns none, or false for an invalid player or item key.

Examples

Check how many copies of a sword a player owns:

local count = getPlayerItemCount(playerId, "1h_sword_01")
if count and count > 0 then
    outputChatBox("Sword available", playerId)
end

Notes

  • Available only in server-side resource scripts.
  • Inventory is server-authoritative. The runtime cache is updated by accepted native world-item pickups and drops, completed native consumable uses, and successful Lua inventory mutations.