GetPlayerWeapon - Revision history

QCherry: Release 0.1.4 BUILD133 / Protocol 36 and document authenticated event origin

2026-09-21T20:40:35Z

Release 0.1.4 BUILD133 / Protocol 36 and document authenticated event origin

← Older revision		Revision as of 20:40, 21 September 2026
Line 1:		Line 1:
	= getPlayerWeapon =		= getPlayerWeapon =
	'''0.1.4 compatibility note ~~(in development)~~: this existing server function remains a legacy single-key view. Use the new confirmation APIs for a native two-slot loadout.'''		'''0.1.4 compatibility note: this existing server function remains a legacy single-key view. Use the new confirmation APIs for a native two-slot loadout.'''

	Returns the player's legacy server-side weapon key. It is not a direct read of both native equipment slots and must not be used as proof that an asynchronous weapon request completed.		Returns the player's legacy server-side weapon key. It is not a direct read of both native equipment slots and must not be used as proof that an asynchronous weapon request completed.

QCherry: Clarify 0.1.4 weapon clearing, manual equipment and confirmation APIs

2026-09-20T13:42:02Z

Clarify 0.1.4 weapon clearing, manual equipment and confirmation APIs

← Older revision		Revision as of 13:42, 20 September 2026
Line 1:		Line 1:
	~~<!-- This page is generated automatically from the function definition: getPlayerWeapon. -->~~
	= getPlayerWeapon =		= getPlayerWeapon =
	Returns the ~~stable~~ key of ~~the~~ weapon ~~equipped by a player~~.		'''0.1.4 compatibility note (in development): this existing server function remains a legacy single-key view. Use the new confirmation APIs for a native two-slot loadout.'''

			Returns the player's legacy server-side weapon key. It is not a direct read of both native equipment slots and must not be used as proof that an asynchronous weapon request completed.

	== Syntax ==		== Syntax ==
Line 16:		Line 17:

	== Returns ==		== Returns ==
	~~Returns the equipped~~ weapon key, an empty string when ~~the slot~~ is clear, or <code>false</code> for an invalid player.		The legacy server-side weapon key, an empty string when that key is clear, or <code>false</code> for an invalid player. In 0.1.4, accepted requests and validated equipment observations can update this key; it does not represent both slots or a completion guarantee.

	== ~~Examples~~ ==		== Example ==
	~~Read a player's equipped weapon:~~		<syntaxhighlight lang="lua">
	<syntaxhighlight lang="lua" ~~line~~>
	local itemKey = getPlayerWeapon(playerId)		local itemKey = getPlayerWeapon(playerId)
	if itemKey and itemKey ~= "" then		if itemKey and itemKey ~= "" then
	outputDebugString("~~Equipped~~ weapon: " .. itemKey)		outputDebugString("Server weapon key: " .. itemKey)
	end		end
	</syntaxhighlight>		</syntaxhighlight>

	== ~~Notes~~ ==		== Confirmed equipment since 0.1.4 ==
	* Available only in server-side resource scripts.		Use [[getPlayerWeaponState]] to inspect separate <code>melee</code> and <code>ranged</code> observations, their freshness and pending requests. Use [[onPlayerWeaponChangeResult]] to sequence dependent scripted changes. A failed request does not automatically roll back the legacy key.
	* Equipment state is server~~-authoritative and included in player synchronization~~.
			The updated server clears the persistent key after a validated successful <code>"none"</code> request, preventing earlier equipment observations from preserving the old weapon. This does not prevent later manual equipment changes.

			See [[Weapon control]] and [[setPlayerWeapon]].
	[[Category:Lua Functions]]		[[Category:Lua Functions]]
	[[Category:Server Functions]]		[[Category:Server Functions]]
	[[Category:Player Functions]]		[[Category:Player Functions]]
	[[Category:Equipment Functions]]		[[Category:Equipment Functions]]

	~~<!-- weapon-mouse014:start -->~~
	~~== Native confirmation since 0.1.4 (in development) ==~~
	See [[Weapon control]]. setPlayerWeapon returns request acceptance, not completion. getPlayerWeapon remains the legacy single scripted choice, not the actual two-slot loadout. Use [[getPlayerWeaponState]] and [[onPlayerWeaponChangeResult]] for confirmed equipment. Matching client and server are required.
	~~<!-- weapon-mouse014:end -->~~

QCherry: Document upcoming 0.1.4 weapon confirmation and mouse camera APIs

2026-09-19T13:53:59Z

Document upcoming 0.1.4 weapon confirmation and mouse camera APIs

← Older revision		Revision as of 13:53, 19 September 2026
Line 35:		Line 35:
	[[Category:Player Functions]]		[[Category:Player Functions]]
	[[Category:Equipment Functions]]		[[Category:Equipment Functions]]

			<!-- weapon-mouse014:start -->
			== Native confirmation since 0.1.4 (in development) ==
			See [[Weapon control]]. setPlayerWeapon returns request acceptance, not completion. getPlayerWeapon remains the legacy single scripted choice, not the actual two-slot loadout. Use [[getPlayerWeaponState]] and [[onPlayerWeaponChangeResult]] for confirmed equipment. Matching client and server are required.
			<!-- weapon-mouse014:end -->

QCherry: Complete Lua function catalog

2026-08-15T09:53:35Z

Complete Lua function catalog

← Older revision		Revision as of 09:53, 15 August 2026
Line 31:		Line 31:
	* Equipment state is server-authoritative and included in player synchronization.		* Equipment state is server-authoritative and included in player synchronization.

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

QCherry: Automatyczna aktualizacja dokumentacji funkcji

2026-08-05T20:13:23Z

Automatyczna aktualizacja dokumentacji funkcji

New page

= getPlayerWeapon =
Returns the stable key of the weapon equipped by a player.

== Syntax ==
<syntaxhighlight lang="lua">
string|false getPlayerWeapon(int playerId)
</syntaxhighlight>

== Parameters ==
{| class="wikitable"
! Name !! Type !! Required !! Description
|-
| <code>playerId</code> || <code>int</code> || yes || The connected player identifier.
|}

== Returns ==
Returns the equipped weapon key, an empty string when the slot is clear, or <code>false</code> for an invalid player.

== Examples ==
Read a player's equipped weapon:
<syntaxhighlight lang="lua" line>
local itemKey = getPlayerWeapon(playerId)
if itemKey and itemKey ~= "" then
outputDebugString("Equipped weapon: " .. itemKey)
end
</syntaxhighlight>

== Notes ==
* Available only in server-side resource scripts.
* Equipment state is server-authoritative and included in player synchronization.

[[Category:Server Functions]]
[[Category:Player Functions]]
[[Category:Equipment Functions]]