GetPlayerItemCount - Revision history

QCherry: Document Lua APIs available or improved from G1R:MP 0.1.2

2026-09-03T18:40:35Z

Document Lua APIs available or improved from G1R:MP 0.1.2

← Older revision		Revision as of 18:40, 3 September 2026
Line 1:		Line 1:
	~~<!-- This page is generated automatically from the function definition: getPlayerItemCount. -->~~
	= getPlayerItemCount =		= getPlayerItemCount =
	Returns the ~~authoritative~~ quantity of a known inventory item ~~owned by a~~ player.		<div style="background:#fff5f5; border:1px solid #d13b3b; border-left:5px solid #d13b3b; color:#111111; padding:0.85rem 1rem; margin:0.75rem 0 1rem;">
			<div style="color:#111111; font-weight:bold; letter-spacing:0.04em;">IMPROVED FROM UPDATE 0.1.2</div>
			<div style="color:#111111; margin-top:0.25rem;">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.</div>
			</div>

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

	== Syntax ==		== Syntax ==
Line 31:		Line 35:
	== Notes ==		== Notes ==
	* Available only in server-side resource scripts.		* Available only in server-side resource scripts.
	* Inventory is server-authoritative.		* 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.

	[[Category:Lua Functions]]		[[Category:Lua Functions]]

QCherry: Complete Lua function catalog

2026-08-15T09:53:03Z

Complete Lua function catalog

← Older revision		Revision as of 09:53, 15 August 2026
Line 33:		Line 33:
	* Inventory is server-authoritative.		* Inventory is server-authoritative.

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

QCherry: Automatyczna aktualizacja dokumentacji funkcji

2026-08-05T20:13:07Z

Automatyczna aktualizacja dokumentacji funkcji

New page

= getPlayerItemCount =
Returns the authoritative quantity of a known inventory item owned by a player.

== Syntax ==
<syntaxhighlight lang="lua">
int|false getPlayerItemCount(int playerId, string itemKey)
</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.
|}

== Returns ==
Returns the item quantity, including 0 when the player owns none, or <code>false</code> for an invalid player or item key.

== Examples ==
Check how many copies of a sword a player owns:
<syntaxhighlight lang="lua" line>
local count = getPlayerItemCount(playerId, "1h_sword_01")
if count and count > 0 then
outputChatBox("Sword available", playerId)
end
</syntaxhighlight>

== Notes ==
* Available only in server-side resource scripts.
* Inventory is server-authoritative.

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