SetPlayerArmor - Revision history

QCherry: Document 0.1a Lua API, identities, moderation and synchronized spells

2026-08-27T11:36:34Z

Document 0.1a Lua API, identities, moderation and synchronized spells

← Older revision		Revision as of 11:36, 27 August 2026
Line 1:		Line 1:
	~~<!-- This page is generated automatically from the function definition: setPlayerArmor. -->~~
	= setPlayerArmor =		= setPlayerArmor =
	Equips or clears a player's authoritative armor slot.		Equips or clears a player's authoritative armor slot.
Line 39:		Line 38:
	* The player must own at least one copy of a non-empty item before it can be equipped.		* The player must own at least one copy of a non-empty item before it can be equipped.
	* The selected appearance is reliably synchronized and included in late-join state.		* The selected appearance is reliably synchronized and included in late-join state.
	* ~~A named body preset visually displays its original outfit or~~ armor~~; use <code>setPlayerBody(playerId, "default")<~~/~~code> to show the independently equipped~~ armor.		* Gothic Remake character variants have identity-specific armor support. Not every identity/armor combination exists or renders correctly; test every combination exposed by a resource.

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

QCherry: Clarify player appearance API behavior

2026-08-15T21:43:37Z

Clarify player appearance API behavior

← Older revision		Revision as of 21:43, 15 August 2026
Line 39:		Line 39:
	* The player must own at least one copy of a non-empty item before it can be equipped.		* The player must own at least one copy of a non-empty item before it can be equipped.
	* The selected appearance is reliably synchronized and included in late-join state.		* The selected appearance is reliably synchronized and included in late-join state.
			* A named body preset visually displays its original outfit or armor; use <code>setPlayerBody(playerId, "default")</code> to show the independently equipped armor.

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

QCherry: Complete Lua function catalog

2026-08-15T09:55:13Z

Complete Lua function catalog

← Older revision		Revision as of 09:55, 15 August 2026
Line 40:		Line 40:
	* The selected appearance is reliably synchronized and included in late-join state.		* The selected appearance is reliably synchronized and included in late-join state.

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

QCherry: Automatyczna aktualizacja dokumentacji funkcji

2026-08-05T20:13:55Z

Automatyczna aktualizacja dokumentacji funkcji

New page

= setPlayerArmor =
Equips or clears a player's authoritative armor slot.

== Syntax ==
<syntaxhighlight lang="lua">
bool setPlayerArmor(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 key returned by <code>getPlayerArmorNames</code>, or <code>"none"</code> to clear the slot.
|}

== Returns ==
Returns <code>true</code> when the equipment change is accepted and replicated; otherwise returns <code>false</code>.

== Examples ==
=== Example 1 ===
Give an item and equip it in the armor slot:
<syntaxhighlight lang="lua" line>
local itemKey = "water_robe"
if givePlayerItem(playerId, itemKey) then
setPlayerArmor(playerId, itemKey)
end
</syntaxhighlight>
=== Example 2 ===
Clear the armor slot:
<syntaxhighlight lang="lua" line>
setPlayerArmor(playerId, "none")
</syntaxhighlight>

== Notes ==
* Available only in server-side resource scripts.
* The player must own at least one copy of a non-empty item before it can be equipped.
* The selected appearance is reliably synchronized and included in late-join state.

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