Wiki G1R-MP G1 Remake Multiplayer - Recent changes [en]

SetPlayerName

QCherry — Tue, 04 Aug 2026 16:29:59 GMT

Document authoritative player name functions

New page

= setPlayerName =
Changes a connected player's authoritative multiplayer name.

== Syntax ==
<syntaxhighlight lang="lua">
bool setPlayerName(int playerId, string playerName)
</syntaxhighlight>

== Parameters ==
{| class="wikitable"
! Name !! Type !! Required !! Description
|-
| <code>playerId</code> || <code>int</code> || yes || The connected player whose name will be changed.
|-
| <code>playerName</code> || <code>string</code> || yes || A unique name containing 3-16 ASCII letters, digits, spaces, underscores or hyphens.
|}

== Returns ==
Returns <code>true</code> when the server accepts the new name; otherwise returns <code>false</code>.

== Examples ==
Create a private /name command:
<syntaxhighlight lang="lua" line>
addCommandHandler("name", function(playerId, commandName, ...)
local requestedName = table.concat({...}, " ")

if setPlayerName(playerId, requestedName) then
outputChatBox("Your name is now " .. getPlayerName(playerId) .. ".", playerId)
else
outputChatBox("That player name is invalid or already in use.", playerId)
end
end)
</syntaxhighlight>

== Notes ==
* Available only in server-side resource scripts.
* Names are trimmed and must be 3-16 characters long.
* Allowed characters are A-Z, a-z, 0-9, spaces, underscores and hyphens. Consecutive spaces are rejected.
* Names must be unique among connected players; uniqueness is checked case-insensitively.
* Successful changes are replicated to clients and raise <code>onPlayerNameChange</code>.

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

GetPlayerName

QCherry — Tue, 04 Aug 2026 16:29:48 GMT

Document authoritative player name functions

New page

= getPlayerName =
Returns the authoritative multiplayer name of a connected player.

== Syntax ==
<syntaxhighlight lang="lua">
string getPlayerName(int playerId)
</syntaxhighlight>

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

== Returns ==
Returns the player's current name as a string, or <code>false</code> when the player is not connected.

== Examples ==
Greet a player when they join:
<syntaxhighlight lang="lua" line>
addEventHandler("onPlayerJoin", function(playerId)
local name = getPlayerName(playerId)
if name then
outputChatBox("Welcome, " .. name .. "!")
end
end)
</syntaxhighlight>

== Notes ==
* Available only in server-side resource scripts.
* Player names are authoritative on the server and are replicated to connected clients.

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

TriggerServerEvent

QCherry — Tue, 04 Aug 2026 12:53:47 GMT

Automatyczna aktualizacja dokumentacji funkcji

← Older revision		Revision as of 12:53, 4 August 2026
Line 31:		Line 31:
	* Available only in client-side resource scripts.		* Available only in client-side resource scripts.
	* The server must declare the event with <code>addEvent(eventName, true)</code> and validate the true sender before changing authoritative state.		* The server must declare the event with <code>addEvent(eventName, true)</code> and validate the true sender before changing authoritative state.
			* The authenticated sender's player ID is passed to the server handler before the values supplied by the client.

	[[Category:Client Functions]]		[[Category:Client Functions]]
	[[Category:Network Functions]]		[[Category:Network Functions]]
	[[Category:Event Functions]]		[[Category:Event Functions]]

GetPlayerProgression

QCherry — Tue, 04 Aug 2026 12:53:34 GMT

Automatyczna aktualizacja dokumentacji funkcji

← Older revision		Revision as of 12:53, 4 August 2026
Line 23:		Line 23:
	local progression = getPlayerProgression(playerId)		local progression = getPlayerProgression(playerId)
	if progression then		if progression then
	print("Level:", progression.level)		print("Level:", progression.stats.level)
	print("Guild:", progression.guild)		print("Guild:", progression.guild)
	end		end

GetPlayerMagicState

QCherry — Tue, 04 Aug 2026 12:53:32 GMT

Automatyczna aktualizacja dokumentacji funkcji

← Older revision		Revision as of 12:53, 4 August 2026
Line 22:		Line 22:
	<syntaxhighlight lang="lua" line>		<syntaxhighlight lang="lua" line>
	local magic = getPlayerMagicState(playerId)		local magic = getPlayerMagicState(playerId)
	if magic and magic.activeSpell then		if magic and magic.activeSpell ~= "none" then
	print("Cast phase:", magic.phase)		print("Cast phase:", magic.phase)
	print("Spell:", magic.activeSpell)		print("Spell:", magic.activeSpell)

DbPoll

QCherry — Tue, 04 Aug 2026 12:53:30 GMT

Automatyczna aktualizacja dokumentacji funkcji

← Older revision		Revision as of 12:53, 4 August 2026
Line 20:		Line 20:

	== Returns ==		== Returns ==
	Returns <code>nil</code> while pending; <code>false, errorCode, errorMessage</code> on failure; or a rows ~~table followed by count~~/~~affected-row metadata~~ on success.		Returns <code>nil</code> while pending; <code>false, errorCode, errorMessage</code> on failure; or <code>rows, rowOrAffectedCount, lastInsertId</code> on success.

	== Examples ==		== Examples ==

TriggerServerEvent

QCherry — Tue, 04 Aug 2026 12:45:47 GMT

Automatyczna aktualizacja dokumentacji funkcji

New page

= triggerServerEvent =
Sends a reliable ordered resource event from the local client to the server.

== Syntax ==
<syntaxhighlight lang="lua">
bool triggerServerEvent(string eventName, element sourceElement, ...)
</syntaxhighlight>

== Parameters ==
{| class="wikitable"
! Name !! Type !! Required !! Description
|-
| <code>eventName</code> || <code>string</code> || yes || The server event name, up to 128 bytes.
|-
| <code>sourceElement</code> || <code>element</code> || yes || The event source; normally <code>root</code>.
|-
| <code>...</code> || <code>nil/bool/number/string</code> || no || Values sent with the event.
|}

== Returns ==
Returns <code>true</code> when the event is queued for transmission; otherwise returns <code>false</code>.

== Examples ==
Request an item from the server:
<syntaxhighlight lang="lua" line>
triggerServerEvent("inventory:requestItem", root, "ITMW_1H_SWORD_01")
</syntaxhighlight>

== Notes ==
* Available only in client-side resource scripts.
* The server must declare the event with <code>addEvent(eventName, true)</code> and validate the true sender before changing authoritative state.

[[Category:Client Functions]]
[[Category:Network Functions]]
[[Category:Event Functions]]

TriggerEvent

QCherry — Tue, 04 Aug 2026 12:45:46 GMT

Automatyczna aktualizacja dokumentacji funkcji

New page

= triggerEvent =
Triggers a custom event inside the current runtime.

== Syntax ==
<syntaxhighlight lang="lua">
bool triggerEvent(string eventName, element sourceElement, ...)
</syntaxhighlight>

== Parameters ==
{| class="wikitable"
! Name !! Type !! Required !! Description
|-
| <code>eventName</code> || <code>string</code> || yes || The custom event name.
|-
| <code>sourceElement</code> || <code>element</code> || yes || The source exposed to event handlers.
|-
| <code>...</code> || <code>nil/bool/number/string</code> || yes || Optional event arguments.
|}

== Returns ==
Returns <code>true</code> when the event is dispatched successfully; otherwise returns <code>false</code>.

== Examples ==
Trigger a local resource event:
<syntaxhighlight lang="lua" line>
addEvent("round:started")
addEventHandler("round:started", root, function(roundNumber)
print("Round", roundNumber, "started")
end)

triggerEvent("round:started", root, 3)
</syntaxhighlight>

== Notes ==
* Available in both client-side and server-side resource scripts.
* Event arguments are limited to nil, boolean, number and string values.

[[Category:Shared Functions]]
[[Category:Event Functions]]

TriggerClientEvent

QCherry — Tue, 04 Aug 2026 12:45:44 GMT

Automatyczna aktualizacja dokumentacji funkcji

New page

= triggerClientEvent =
Sends a reliable ordered resource event from the server to one player or all players.

== Syntax ==
<syntaxhighlight lang="lua">
bool triggerClientEvent(root|int target, string eventName, element sourceElement, ...)
</syntaxhighlight>

== Parameters ==
{| class="wikitable"
! Name !! Type !! Required !! Description
|-
| <code>target</code> || <code>root{{!}}int</code> || yes || Use a player id for one client, or root/nil to broadcast.
|-
| <code>eventName</code> || <code>string</code> || yes || The client event name.
|-
| <code>sourceElement</code> || <code>element</code> || yes || The event source; normally <code>root</code>.
|-
| <code>...</code> || <code>nil/bool/number/string</code> || no || Values sent with the event.
|}

== Returns ==
Returns <code>true</code> when the event is queued for transmission; otherwise returns <code>false</code>.

== Examples ==
Display a client notification for one player:
<syntaxhighlight lang="lua" line>
triggerClientEvent(playerId, "ui:notification", root, "Quest completed")
</syntaxhighlight>

== Notes ==
* Available only in server-side resource scripts.
* The client resource must declare the event with <code>addEvent(eventName, true)</code>. Network arguments are limited to nil, boolean, number and string.

[[Category:Server Functions]]
[[Category:Network Functions]]
[[Category:Event Functions]]

SetTimer

QCherry — Tue, 04 Aug 2026 12:45:43 GMT

Automatyczna aktualizacja dokumentacji funkcji

New page

= setTimer =
Schedules a Lua function to run after a delay, optionally more than once.

== Syntax ==
<syntaxhighlight lang="lua">
int setTimer(function callback, int intervalMs, int timesToExecute, ...)
</syntaxhighlight>

== Parameters ==
{| class="wikitable"
! Name !! Type !! Required !! Description
|-
| <code>callback</code> || <code>function</code> || yes || The function to execute.
|-
| <code>intervalMs</code> || <code>int</code> || yes || Delay between executions in milliseconds. The minimum is 10.
|-
| <code>timesToExecute</code> || <code>int</code> || yes || Number of executions. Use 0 to repeat indefinitely.
|-
| <code>...</code> || <code>any</code> || no || Optional values passed to the callback each time it runs.
|}

== Returns ==
Returns a positive timer identifier on success, or <code>0</code> when the timer could not be created.

== Examples ==
Print a message three times at one-second intervals:
<syntaxhighlight lang="lua" line>
local timer = setTimer(function(message)
print(message)
end, 1000, 3, "One second passed")
</syntaxhighlight>

== Notes ==
* Available in both client-side and server-side resource scripts.

[[Category:Shared Functions]]
[[Category:Timer Functions]]
[[Category:Utility Functions]]

SetPlayerStrength

QCherry — Tue, 04 Aug 2026 12:45:41 GMT

Automatyczna aktualizacja dokumentacji funkcji

New page

= setPlayerStrength =
Sets a player's authoritative strength value.

== Syntax ==
<syntaxhighlight lang="lua">
bool setPlayerStrength(int playerId, number value)
</syntaxhighlight>

== Parameters ==
{| class="wikitable"
! Name !! Type !! Required !! Description
|-
| <code>playerId</code> || <code>int</code> || yes || The connected player to update.
|-
| <code>value</code> || <code>number</code> || yes || The new strength value.
|}

== Returns ==
Returns <code>true</code> when the value is accepted; otherwise returns <code>false</code>.

== Examples ==
Set a player's strength:
<syntaxhighlight lang="lua" line>
setPlayerStrength(playerId, 50)
</syntaxhighlight>

== Notes ==
* Available only in server-side resource scripts.
* This is a convenience wrapper around <code>setPlayerStat(playerId, "strength", value)</code>.

[[Category:Server Functions]]
[[Category:Progression Functions]]
[[Category:Player Functions]]

SetPlayerStat

QCherry — Tue, 04 Aug 2026 12:45:40 GMT

Automatyczna aktualizacja dokumentacji funkcji

New page

= setPlayerStat =
Sets an authoritative numeric progression stat for a connected player.

== Syntax ==
<syntaxhighlight lang="lua">
bool setPlayerStat(int playerId, string statName, number value)
</syntaxhighlight>

== Parameters ==
{| class="wikitable"
! Name !! Type !! Required !! Description
|-
| <code>playerId</code> || <code>int</code> || yes || The connected player to update.
|-
| <code>statName</code> || <code>string</code> || yes || A supported stat key.
|-
| <code>value</code> || <code>number</code> || yes || The new value, clamped to the stat's allowed range.
|}

== Returns ==
Returns <code>true</code> when the update is accepted; otherwise returns <code>false</code>.

== Examples ==
Set a player's strength:
<syntaxhighlight lang="lua" line>
if not setPlayerStat(playerId, "strength", 50) then
outputDebugString("Could not set strength", 1)
end
</syntaxhighlight>

== Notes ==
* Available only in server-side resource scripts.
* Progression changes are server-authoritative and replicated to the owning client.

[[Category:Server Functions]]
[[Category:Progression Functions]]
[[Category:Player Functions]]

SetPlayerSpellGranted

QCherry — Tue, 04 Aug 2026 12:45:38 GMT

Automatyczna aktualizacja dokumentacji funkcji

New page

= setPlayerSpellGranted =
Sets or clears an authoritative spell grant for a player.

== Syntax ==
<syntaxhighlight lang="lua">
bool setPlayerSpellGranted(int playerId, int|string spell [, bool enabled = true])
</syntaxhighlight>

== Parameters ==
{| class="wikitable"
! Name !! Type !! Required !! Description
|-
| <code>playerId</code> || <code>int</code> || yes || The connected player to update.
|-
| <code>spell</code> || <code>int{{!}}string</code> || yes || A spell id or stable key.
|-
| <code>enabled</code> || <code>bool</code> || no || True to grant the spell, false to revoke it.
|}

== Returns ==
Returns <code>true</code> when the grant state is accepted; otherwise returns <code>false</code>.

== Examples ==
Grant Fire Arrow to a player:
<syntaxhighlight lang="lua" line>
setPlayerSpellGranted(playerId, SPELL.FIRE_ARROW, true)
</syntaxhighlight>

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

[[Category:Server Functions]]
[[Category:Magic Functions]]
[[Category:Progression Functions]]

SetPlayerSkillPoints

QCherry — Tue, 04 Aug 2026 12:45:37 GMT

Automatyczna aktualizacja dokumentacji funkcji

New page

= setPlayerSkillPoints =
Sets a player's authoritative available skill points value.

== Syntax ==
<syntaxhighlight lang="lua">
bool setPlayerSkillPoints(int playerId, number value)
</syntaxhighlight>

== Parameters ==
{| class="wikitable"
! Name !! Type !! Required !! Description
|-
| <code>playerId</code> || <code>int</code> || yes || The connected player to update.
|-
| <code>value</code> || <code>number</code> || yes || The new available skill points value.
|}

== Returns ==
Returns <code>true</code> when the value is accepted; otherwise returns <code>false</code>.

== Examples ==
Set a player's available skill points:
<syntaxhighlight lang="lua" line>
setPlayerSkillPoints(playerId, 50)
</syntaxhighlight>

== Notes ==
* Available only in server-side resource scripts.
* This is a convenience wrapper around <code>setPlayerStat(playerId, "skill_points", value)</code>.

[[Category:Server Functions]]
[[Category:Progression Functions]]
[[Category:Player Functions]]

SetPlayerSkill

QCherry — Tue, 04 Aug 2026 12:45:35 GMT

Automatyczna aktualizacja dokumentacji funkcji

New page

= setPlayerSkill =
Enables or disables an authoritative boolean player skill.

== Syntax ==
<syntaxhighlight lang="lua">
bool setPlayerSkill(int playerId, string skillName, bool enabled)
</syntaxhighlight>

== Parameters ==
{| class="wikitable"
! Name !! Type !! Required !! Description
|-
| <code>playerId</code> || <code>int</code> || yes || The connected player to update.
|-
| <code>skillName</code> || <code>string</code> || yes || A key returned by <code>getPlayerSkillNames</code>.
|-
| <code>enabled</code> || <code>bool</code> || yes || Whether the skill should be enabled.
|}

== Returns ==
Returns <code>true</code> when the skill state is accepted; otherwise returns <code>false</code>.

== Examples ==
Teach a player the acrobatics skill:
<syntaxhighlight lang="lua" line>
setPlayerSkill(playerId, "acrobatics", true)
</syntaxhighlight>

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

[[Category:Server Functions]]
[[Category:Progression Functions]]
[[Category:Player Functions]]

SetPlayerMaxMana

QCherry — Tue, 04 Aug 2026 12:45:34 GMT

Automatyczna aktualizacja dokumentacji funkcji

New page

= setPlayerMaxMana =
Sets a player's authoritative maximum mana value.

== Syntax ==
<syntaxhighlight lang="lua">
bool setPlayerMaxMana(int playerId, number value)
</syntaxhighlight>

== Parameters ==
{| class="wikitable"
! Name !! Type !! Required !! Description
|-
| <code>playerId</code> || <code>int</code> || yes || The connected player to update.
|-
| <code>value</code> || <code>number</code> || yes || The new maximum mana value.
|}

== Returns ==
Returns <code>true</code> when the value is accepted; otherwise returns <code>false</code>.

== Examples ==
Set a player's maximum mana:
<syntaxhighlight lang="lua" line>
setPlayerMaxMana(playerId, 50)
</syntaxhighlight>

== Notes ==
* Available only in server-side resource scripts.
* This is a convenience wrapper around <code>setPlayerStat(playerId, "max_mana", value)</code>.

[[Category:Server Functions]]
[[Category:Progression Functions]]
[[Category:Player Functions]]

SetPlayerMaxHealth

QCherry — Tue, 04 Aug 2026 12:45:32 GMT

Automatyczna aktualizacja dokumentacji funkcji

New page

= setPlayerMaxHealth =
Sets a player's authoritative maximum health value.

== Syntax ==
<syntaxhighlight lang="lua">
bool setPlayerMaxHealth(int playerId, number value)
</syntaxhighlight>

== Parameters ==
{| class="wikitable"
! Name !! Type !! Required !! Description
|-
| <code>playerId</code> || <code>int</code> || yes || The connected player to update.
|-
| <code>value</code> || <code>number</code> || yes || The new maximum health value.
|}

== Returns ==
Returns <code>true</code> when the value is accepted; otherwise returns <code>false</code>.

== Examples ==
Set a player's maximum health:
<syntaxhighlight lang="lua" line>
setPlayerMaxHealth(playerId, 50)
</syntaxhighlight>

== Notes ==
* Available only in server-side resource scripts.
* This is a convenience wrapper around <code>setPlayerStat(playerId, "max_health", value)</code>.

[[Category:Server Functions]]
[[Category:Progression Functions]]
[[Category:Player Functions]]

SetPlayerMana

QCherry — Tue, 04 Aug 2026 12:45:31 GMT

Automatyczna aktualizacja dokumentacji funkcji

New page

= setPlayerMana =
Sets a player's authoritative current mana value.

== Syntax ==
<syntaxhighlight lang="lua">
bool setPlayerMana(int playerId, number value)
</syntaxhighlight>

== Parameters ==
{| class="wikitable"
! Name !! Type !! Required !! Description
|-
| <code>playerId</code> || <code>int</code> || yes || The connected player to update.
|-
| <code>value</code> || <code>number</code> || yes || The new current mana value.
|}

== Returns ==
Returns <code>true</code> when the value is accepted; otherwise returns <code>false</code>.

== Examples ==
Set a player's current mana:
<syntaxhighlight lang="lua" line>
setPlayerMana(playerId, 50)
</syntaxhighlight>

== Notes ==
* Available only in server-side resource scripts.
* This is a convenience wrapper around <code>setPlayerStat(playerId, "mana", value)</code>.

[[Category:Server Functions]]
[[Category:Progression Functions]]
[[Category:Player Functions]]

SetPlayerMagicCircle

QCherry — Tue, 04 Aug 2026 12:45:30 GMT

Automatyczna aktualizacja dokumentacji funkcji

New page

= setPlayerMagicCircle =
Sets the authoritative magic circle and updates the related circle skills coherently.

== Syntax ==
<syntaxhighlight lang="lua">
bool setPlayerMagicCircle(int playerId, int circle)
</syntaxhighlight>

== Parameters ==
{| class="wikitable"
! Name !! Type !! Required !! Description
|-
| <code>playerId</code> || <code>int</code> || yes || The connected player to update.
|-
| <code>circle</code> || <code>int</code> || yes || Magic circle from 0 through 6.
|}

== Returns ==
Returns <code>true</code> when the circle is accepted; otherwise returns <code>false</code>.

== Examples ==
Grant the sixth circle of magic:
<syntaxhighlight lang="lua" line>
setPlayerMagicCircle(playerId, 6)
</syntaxhighlight>

== Notes ==
* Available only in server-side resource scripts.
* The function updates <code>magician_level</code> and the corresponding circle skill flags as one authoritative operation.

[[Category:Server Functions]]
[[Category:Magic Functions]]
[[Category:Progression Functions]]

SetPlayerLevel

QCherry — Tue, 04 Aug 2026 12:45:28 GMT

Automatyczna aktualizacja dokumentacji funkcji

New page

= setPlayerLevel =
Sets a player's authoritative character level value.

== Syntax ==
<syntaxhighlight lang="lua">
bool setPlayerLevel(int playerId, number value)
</syntaxhighlight>

== Parameters ==
{| class="wikitable"
! Name !! Type !! Required !! Description
|-
| <code>playerId</code> || <code>int</code> || yes || The connected player to update.
|-
| <code>value</code> || <code>number</code> || yes || The new character level value.
|}

== Returns ==
Returns <code>true</code> when the value is accepted; otherwise returns <code>false</code>.

== Examples ==
Set a player's character level:
<syntaxhighlight lang="lua" line>
setPlayerLevel(playerId, 50)
</syntaxhighlight>

== Notes ==
* Available only in server-side resource scripts.
* This is a convenience wrapper around <code>setPlayerStat(playerId, "level", value)</code>.

[[Category:Server Functions]]
[[Category:Progression Functions]]
[[Category:Player Functions]]

SetPlayerHealth

QCherry — Tue, 04 Aug 2026 12:45:27 GMT

Automatyczna aktualizacja dokumentacji funkcji

New page

= setPlayerHealth =
Sets a player's authoritative current health value.

== Syntax ==
<syntaxhighlight lang="lua">
bool setPlayerHealth(int playerId, number value)
</syntaxhighlight>

== Parameters ==
{| class="wikitable"
! Name !! Type !! Required !! Description
|-
| <code>playerId</code> || <code>int</code> || yes || The connected player to update.
|-
| <code>value</code> || <code>number</code> || yes || The new current health value.
|}

== Returns ==
Returns <code>true</code> when the value is accepted; otherwise returns <code>false</code>.

== Examples ==
Set a player's current health:
<syntaxhighlight lang="lua" line>
setPlayerHealth(playerId, 50)
</syntaxhighlight>

== Notes ==
* Available only in server-side resource scripts.
* This is a convenience wrapper around <code>setPlayerStat(playerId, "health", value)</code>.

[[Category:Server Functions]]
[[Category:Progression Functions]]
[[Category:Player Functions]]

SetPlayerGuild

QCherry — Tue, 04 Aug 2026 12:45:25 GMT

Automatyczna aktualizacja dokumentacji funkcji

New page

= setPlayerGuild =
Sets a player's authoritative guild membership.

== Syntax ==
<syntaxhighlight lang="lua">
bool setPlayerGuild(int playerId, string guildName)
</syntaxhighlight>

== Parameters ==
{| class="wikitable"
! Name !! Type !! Required !! Description
|-
| <code>playerId</code> || <code>int</code> || yes || The connected player to update.
|-
| <code>guildName</code> || <code>string</code> || yes || A key returned by <code>getPlayerGuildNames</code>.
|}

== Returns ==
Returns <code>true</code> when the guild is accepted; otherwise returns <code>false</code>.

== Examples ==
Assign a player to a guild:
<syntaxhighlight lang="lua" line>
setPlayerGuild(playerId, "old_camp")
</syntaxhighlight>

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

[[Category:Server Functions]]
[[Category:Progression Functions]]
[[Category:Player Functions]]

SetPlayerExperience

QCherry — Tue, 04 Aug 2026 12:45:24 GMT

Automatyczna aktualizacja dokumentacji funkcji

New page

= setPlayerExperience =
Sets a player's authoritative experience value.

== Syntax ==
<syntaxhighlight lang="lua">
bool setPlayerExperience(int playerId, number value)
</syntaxhighlight>

== Parameters ==
{| class="wikitable"
! Name !! Type !! Required !! Description
|-
| <code>playerId</code> || <code>int</code> || yes || The connected player to update.
|-
| <code>value</code> || <code>number</code> || yes || The new experience value.
|}

== Returns ==
Returns <code>true</code> when the value is accepted; otherwise returns <code>false</code>.

== Examples ==
Set a player's experience:
<syntaxhighlight lang="lua" line>
setPlayerExperience(playerId, 50)
</syntaxhighlight>

== Notes ==
* Available only in server-side resource scripts.
* This is a convenience wrapper around <code>setPlayerStat(playerId, "experience", value)</code>.

[[Category:Server Functions]]
[[Category:Progression Functions]]
[[Category:Player Functions]]

SetPlayerDexterity

QCherry — Tue, 04 Aug 2026 12:45:22 GMT

Automatyczna aktualizacja dokumentacji funkcji

New page

= setPlayerDexterity =
Sets a player's authoritative dexterity value.

== Syntax ==
<syntaxhighlight lang="lua">
bool setPlayerDexterity(int playerId, number value)
</syntaxhighlight>

== Parameters ==
{| class="wikitable"
! Name !! Type !! Required !! Description
|-
| <code>playerId</code> || <code>int</code> || yes || The connected player to update.
|-
| <code>value</code> || <code>number</code> || yes || The new dexterity value.
|}

== Returns ==
Returns <code>true</code> when the value is accepted; otherwise returns <code>false</code>.

== Examples ==
Set a player's dexterity:
<syntaxhighlight lang="lua" line>
setPlayerDexterity(playerId, 50)
</syntaxhighlight>

== Notes ==
* Available only in server-side resource scripts.
* This is a convenience wrapper around <code>setPlayerStat(playerId, "dexterity", value)</code>.

[[Category:Server Functions]]
[[Category:Progression Functions]]
[[Category:Player Functions]]

RevokePlayerSpell

QCherry — Tue, 04 Aug 2026 12:45:21 GMT

Automatyczna aktualizacja dokumentacji funkcji

New page

= revokePlayerSpell =
Revokes an authoritative spell grant from a player.

== Syntax ==
<syntaxhighlight lang="lua">
bool revokePlayerSpell(int playerId, int|string spell)
</syntaxhighlight>

== Parameters ==
{| class="wikitable"
! Name !! Type !! Required !! Description
|-
| <code>playerId</code> || <code>int</code> || yes || The connected player to update.
|-
| <code>spell</code> || <code>int{{!}}string</code> || yes || A spell id or stable key.
|}

== Returns ==
Returns <code>true</code> when the spell is revoked; otherwise returns <code>false</code>.

== Examples ==
Remove Fire Arrow from a player:
<syntaxhighlight lang="lua" line>
revokePlayerSpell(playerId, SPELL.FIRE_ARROW)
</syntaxhighlight>

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

[[Category:Server Functions]]
[[Category:Magic Functions]]
[[Category:Progression Functions]]

RemoveEventHandler

QCherry — Tue, 04 Aug 2026 12:45:19 GMT

Automatyczna aktualizacja dokumentacji funkcji

New page

= removeEventHandler =
Removes a previously registered event callback.

== Syntax ==
<syntaxhighlight lang="lua">
bool removeEventHandler(string eventName, element attachedTo, function handler)
</syntaxhighlight>

== Parameters ==
{| class="wikitable"
! Name !! Type !! Required !! Description
|-
| <code>eventName</code> || <code>string</code> || yes || The event from which to remove the handler.
|-
| <code>attachedTo</code> || <code>element</code> || yes || The same attachment target used with <code>addEventHandler</code>.
|-
| <code>handler</code> || <code>function</code> || yes || The exact Lua function previously registered.
|}

== Returns ==
Returns <code>true</code> if a matching handler was removed; otherwise returns <code>false</code>.

== Examples ==
Register and later remove a handler:
<syntaxhighlight lang="lua" line>
local function onRoundEnd()
print("Round ended")
end

addEventHandler("round:end", root, onRoundEnd)
removeEventHandler("round:end", root, onRoundEnd)
</syntaxhighlight>

== Notes ==
* Available in both client-side and server-side resource scripts.

[[Category:Shared Functions]]
[[Category:Event Functions]]

RemoveCommandHandler

QCherry — Tue, 04 Aug 2026 12:45:18 GMT

Automatyczna aktualizacja dokumentacji funkcji

New page

= removeCommandHandler =
Removes a command handler owned by the current resource.

== Syntax ==
<syntaxhighlight lang="lua">
bool removeCommandHandler(string commandName)
</syntaxhighlight>

== Parameters ==
{| class="wikitable"
! Name !! Type !! Required !! Description
|-
| <code>commandName</code> || <code>string</code> || yes || Command name without the leading slash.
|}

== Returns ==
Returns <code>true</code> if a handler was removed; otherwise returns <code>false</code>.

== Examples ==
Remove a command during resource shutdown:
<syntaxhighlight lang="lua" line>
removeCommandHandler("heal")
</syntaxhighlight>

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

[[Category:Server Functions]]
[[Category:Command Functions]]
[[Category:Chat Functions]]

Print

QCherry — Tue, 04 Aug 2026 12:45:16 GMT

Automatyczna aktualizacja dokumentacji funkcji

New page

= print =
Writes one or more Lua values to the resource log, separated by tabs.

== Syntax ==
<syntaxhighlight lang="lua">
print(...)
</syntaxhighlight>

== Parameters ==
{| class="wikitable"
! Name !! Type !! Required !! Description
|-
| <code>...</code> || <code>any</code> || yes || Values to print. Strings, numbers, booleans and nil are formatted directly.
|}

== Returns ==
This function does not return a value.

== Examples ==
Print a player's identifier and current state:
<syntaxhighlight lang="lua" line>
local playerId = 7
local state = "ready"
print("Player", playerId, state)
</syntaxhighlight>

== Notes ==
* Available in both client-side and server-side resource scripts.

[[Category:Shared Functions]]
[[Category:Debug Functions]]
[[Category:Utility Functions]]

OutputDebugString

QCherry — Tue, 04 Aug 2026 12:45:15 GMT

Automatyczna aktualizacja dokumentacji funkcji

New page

= outputDebugString =
Writes a message to the resource log at the requested severity level.

== Syntax ==
<syntaxhighlight lang="lua">
bool outputDebugString(string message [, int level = 3])
</syntaxhighlight>

== Parameters ==
{| class="wikitable"
! Name !! Type !! Required !! Description
|-
| <code>message</code> || <code>string</code> || yes || The text to write to the resource log.
|-
| <code>level</code> || <code>int</code> || no || The severity: 1 for error, 2 for warning, or 3 for information.
|}

== Returns ==
Returns <code>true</code> after the message has been accepted.

== Examples ==
Write an informational message to the log:
<syntaxhighlight lang="lua" line>
outputDebugString("The resource has started", 3)
</syntaxhighlight>

== Notes ==
* Available in both client-side and server-side resource scripts.

[[Category:Shared Functions]]
[[Category:Debug Functions]]
[[Category:Utility Functions]]

OutputChatBox

QCherry — Tue, 04 Aug 2026 12:45:13 GMT

Automatyczna aktualizacja dokumentacji funkcji

New page

= outputChatBox =
Sends a chat message to all players, one player, or a table of player identifiers.

== Syntax ==
<syntaxhighlight lang="lua">
bool outputChatBox(string message [, mixed visibleTo = root [, int red = 231 [, int green = 217 [, int blue = 176 [, bool colorCoded = false]]]]])
</syntaxhighlight>

== Parameters ==
{| class="wikitable"
! Name !! Type !! Required !! Description
|-
| <code>message</code> || <code>string</code> || yes || The message to send.
|-
| <code>visibleTo</code> || <code>root{{!}}int{{!}}table</code> || no || Broadcast target: root/nil, one player id, or a table of player ids.
|-
| <code>red</code> || <code>int</code> || no || Red color channel from 0 to 255.
|-
| <code>green</code> || <code>int</code> || no || Green color channel from 0 to 255.
|-
| <code>blue</code> || <code>int</code> || no || Blue color channel from 0 to 255.
|-
| <code>colorCoded</code> || <code>bool</code> || no || Whether inline color codes should be interpreted.
|}

== Returns ==
Returns <code>true</code> when the message is accepted for delivery; otherwise returns <code>false</code>.

== Examples ==
Send a green message to nearby players:
<syntaxhighlight lang="lua" line>
local recipients = getPlayersInRange(playerId, 25, true)
outputChatBox("[Local] " .. message, recipients, 160, 220, 160, false)
</syntaxhighlight>

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

[[Category:Server Functions]]
[[Category:Chat Functions]]
[[Category:Player Functions]]

KillTimer

QCherry — Tue, 04 Aug 2026 12:45:12 GMT

Automatyczna aktualizacja dokumentacji funkcji

New page

= killTimer =
Cancels an active timer.

== Syntax ==
<syntaxhighlight lang="lua">
bool killTimer(int timerId)
</syntaxhighlight>

== Parameters ==
{| class="wikitable"
! Name !! Type !! Required !! Description
|-
| <code>timerId</code> || <code>int</code> || yes || The identifier returned by <code>setTimer</code>.
|}

== Returns ==
Returns <code>true</code> if an active timer was cancelled; otherwise returns <code>false</code>.

== Examples ==
Create and cancel a repeating timer:
<syntaxhighlight lang="lua" line>
local timer = setTimer(function()
print("tick")
end, 1000, 0)

killTimer(timer)
</syntaxhighlight>

== Notes ==
* Available in both client-side and server-side resource scripts.

[[Category:Shared Functions]]
[[Category:Timer Functions]]
[[Category:Utility Functions]]

IsTimer

QCherry — Tue, 04 Aug 2026 12:45:11 GMT

Automatyczna aktualizacja dokumentacji funkcji

New page

= isTimer =
Checks whether a timer identifier still refers to an active timer.

== Syntax ==
<syntaxhighlight lang="lua">
bool isTimer(int timerId)
</syntaxhighlight>

== Parameters ==
{| class="wikitable"
! Name !! Type !! Required !! Description
|-
| <code>timerId</code> || <code>int</code> || yes || The timer identifier to inspect.
|}

== Returns ==
Returns <code>true</code> for an active timer; otherwise returns <code>false</code>.

== Examples ==
Check a timer before cancelling it:
<syntaxhighlight lang="lua" line>
local timer = setTimer(function() end, 5000, 1)
if isTimer(timer) then
killTimer(timer)
end
</syntaxhighlight>

== Notes ==
* Available in both client-side and server-side resource scripts.

[[Category:Shared Functions]]
[[Category:Timer Functions]]
[[Category:Utility Functions]]

IsPlayerSpellGranted

QCherry — Tue, 04 Aug 2026 12:45:09 GMT

Automatyczna aktualizacja dokumentacji funkcji

New page

= isPlayerSpellGranted =
Checks whether a player has an authoritative spell grant.

== Syntax ==
<syntaxhighlight lang="lua">
bool isPlayerSpellGranted(int playerId, int|string spell)
</syntaxhighlight>

== Parameters ==
{| class="wikitable"
! Name !! Type !! Required !! Description
|-
| <code>playerId</code> || <code>int</code> || yes || The connected player to inspect.
|-
| <code>spell</code> || <code>int{{!}}string</code> || yes || A spell id or stable key.
|}

== Returns ==
Returns <code>true</code> if the spell is granted; otherwise returns <code>false</code>.

== Examples ==
Check for Fire Arrow before granting it:
<syntaxhighlight lang="lua" line>
if not isPlayerSpellGranted(playerId, SPELL.FIRE_ARROW) then
grantPlayerSpell(playerId, SPELL.FIRE_ARROW)
end
</syntaxhighlight>

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

[[Category:Server Functions]]
[[Category:Magic Functions]]
[[Category:Player Functions]]

IsPlayerConnected

QCherry — Tue, 04 Aug 2026 12:45:08 GMT

Automatyczna aktualizacja dokumentacji funkcji

New page

= isPlayerConnected =
Checks whether a player identifier belongs to a connected client.

== Syntax ==
<syntaxhighlight lang="lua">
bool isPlayerConnected(int playerId)
</syntaxhighlight>

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

== Returns ==
Returns <code>true</code> when the player is connected; otherwise returns <code>false</code>.

== Examples ==
Validate a player before changing state:
<syntaxhighlight lang="lua" line>
if isPlayerConnected(playerId) then
outputChatBox("You are connected", playerId)
end
</syntaxhighlight>

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

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

GuiShow

QCherry — Tue, 04 Aug 2026 12:45:06 GMT

Automatyczna aktualizacja dokumentacji funkcji

New page

= guiShow =
Shows a loaded RML document.

== Syntax ==
<syntaxhighlight lang="lua">
bool guiShow(DocumentHandle document)
</syntaxhighlight>

== Parameters ==
{| class="wikitable"
! Name !! Type !! Required !! Description
|-
| <code>document</code> || <code>DocumentHandle</code> || yes || The document to show.
|}

== Returns ==
Returns <code>true</code> when the document is shown; otherwise returns <code>false</code>.

== Examples ==
Show a previously loaded menu:
<syntaxhighlight lang="lua" line>
local menu = guiLoadDocument("ui/menu.rml")
guiShow(menu)
</syntaxhighlight>

== Notes ==
* Available only in client-side resource scripts.

[[Category:Client Functions]]
[[Category:GUI Functions]]

GuiSetValue

QCherry — Tue, 04 Aug 2026 12:45:05 GMT

Automatyczna aktualizacja dokumentacji funkcji

New page

= guiSetValue =
Sets the value of an element in a loaded RML document.

== Syntax ==
<syntaxhighlight lang="lua">
bool guiSetValue(DocumentHandle document, string elementId, string value)
</syntaxhighlight>

== Parameters ==
{| class="wikitable"
! Name !! Type !! Required !! Description
|-
| <code>document</code> || <code>DocumentHandle</code> || yes || The owning document.
|-
| <code>elementId</code> || <code>string</code> || yes || The target element's id attribute.
|-
| <code>value</code> || <code>string</code> || yes || The new value.
|}

== Returns ==
Returns <code>true</code> when the value is updated; otherwise returns <code>false</code>.

== Examples ==
Fill a text input:
<syntaxhighlight lang="lua" line>
guiSetValue(chatDocument, "chat-input", "Hello world")
</syntaxhighlight>

== Notes ==
* Available only in client-side resource scripts.

[[Category:Client Functions]]
[[Category:GUI Functions]]

GuiSetInnerRML

QCherry — Tue, 04 Aug 2026 12:45:04 GMT

Automatyczna aktualizacja dokumentacji funkcji

New page

= guiSetInnerRML =
Replaces the child markup of an RML element.

== Syntax ==
<syntaxhighlight lang="lua">
bool guiSetInnerRML(DocumentHandle document, string elementId, string rml)
</syntaxhighlight>

== Parameters ==
{| class="wikitable"
! Name !! Type !! Required !! Description
|-
| <code>document</code> || <code>DocumentHandle</code> || yes || The owning document.
|-
| <code>elementId</code> || <code>string</code> || yes || The target element's id attribute.
|-
| <code>rml</code> || <code>string</code> || yes || RML markup to place inside the element.
|}

== Returns ==
Returns <code>true</code> when the markup is replaced; otherwise returns <code>false</code>.

== Examples ==
Update a status label:
<syntaxhighlight lang="lua" line>
guiSetInnerRML(hudDocument, "status", "<strong>Connected</strong>")
</syntaxhighlight>

== Notes ==
* Available only in client-side resource scripts.
* Only insert trusted or properly escaped text into RML markup.

[[Category:Client Functions]]
[[Category:GUI Functions]]

GuiSetClass

QCherry — Tue, 04 Aug 2026 12:45:02 GMT

Automatyczna aktualizacja dokumentacji funkcji

New page

= guiSetClass =
Adds or removes an RCSS class on an RML element.

== Syntax ==
<syntaxhighlight lang="lua">
bool guiSetClass(DocumentHandle document, string elementId, string className, bool enabled)
</syntaxhighlight>

== Parameters ==
{| class="wikitable"
! Name !! Type !! Required !! Description
|-
| <code>document</code> || <code>DocumentHandle</code> || yes || The owning document.
|-
| <code>elementId</code> || <code>string</code> || yes || The target element's id attribute.
|-
| <code>className</code> || <code>string</code> || yes || The RCSS class name.
|-
| <code>enabled</code> || <code>bool</code> || yes || True to add the class, false to remove it.
|}

== Returns ==
Returns <code>true</code> when the class list is changed; otherwise returns <code>false</code>.

== Examples ==
Highlight a selected inventory slot:
<syntaxhighlight lang="lua" line>
guiSetClass(inventoryDocument, "slot-3", "selected", true)
</syntaxhighlight>

== Notes ==
* Available only in client-side resource scripts.

[[Category:Client Functions]]
[[Category:GUI Functions]]

GuiSetChatActive

QCherry — Tue, 04 Aug 2026 12:45:01 GMT

Automatyczna aktualizacja dokumentacji funkcji

New page

= guiSetChatActive =
Activates or deactivates chat input mode.

== Syntax ==
<syntaxhighlight lang="lua">
bool guiSetChatActive(bool active)
</syntaxhighlight>

== Parameters ==
{| class="wikitable"
! Name !! Type !! Required !! Description
|-
| <code>active</code> || <code>bool</code> || yes || True to capture input for chat, false to return input to the game.
|}

== Returns ==
Returns <code>true</code> when the chat state is changed; otherwise returns <code>false</code>.

== Examples ==
Open chat input and close it shortly afterward:
<syntaxhighlight lang="lua" line>
guiSetChatActive(true)
setTimer(function()
guiSetChatActive(false)
end, 5000, 1)
</syntaxhighlight>

== Notes ==
* Available only in client-side resource scripts.

[[Category:Client Functions]]
[[Category:GUI Functions]]

GuiRegisterChat

QCherry — Tue, 04 Aug 2026 12:44:59 GMT

Automatyczna aktualizacja dokumentacji funkcji

New page

= guiRegisterChat =
Registers an RML document and its composer elements as the resource chat interface.

== Syntax ==
<syntaxhighlight lang="lua">
bool guiRegisterChat(DocumentHandle document, string composerId, string inputId)
</syntaxhighlight>

== Parameters ==
{| class="wikitable"
! Name !! Type !! Required !! Description
|-
| <code>document</code> || <code>DocumentHandle</code> || yes || The chat document.
|-
| <code>composerId</code> || <code>string</code> || yes || The id of the composer container.
|-
| <code>inputId</code> || <code>string</code> || yes || The id of the text input element.
|}

== Returns ==
Returns <code>true</code> when the chat interface is registered; otherwise returns <code>false</code>.

== Examples ==
Register a custom chat document:
<syntaxhighlight lang="lua" line>
local chat = guiLoadDocument("ui/chat.rml")
guiRegisterChat(chat, "chat-composer", "chat-input")
guiShow(chat)
</syntaxhighlight>

== Notes ==
* Available only in client-side resource scripts.
* Only one active chat registration is expected for the client UI.

[[Category:Client Functions]]
[[Category:GUI Functions]]

GuiLoadDocument

QCherry — Tue, 04 Aug 2026 12:44:58 GMT

Automatyczna aktualizacja dokumentacji funkcji

New page

= guiLoadDocument =
Loads an RML document owned by the current client resource.

== Syntax ==
<syntaxhighlight lang="lua">
DocumentHandle guiLoadDocument(string relativePath)
</syntaxhighlight>

== Parameters ==
{| class="wikitable"
! Name !! Type !! Required !! Description
|-
| <code>relativePath</code> || <code>string</code> || yes || Path to the RML file relative to the resource root.
|}

== Returns ==
Returns a document handle on success, or an invalid handle when loading fails.

== Examples ==
Load and display a HUD document:
<syntaxhighlight lang="lua" line>
local hud = guiLoadDocument("ui/hud.rml")
if hud then
guiShow(hud)
end
</syntaxhighlight>

== Notes ==
* Available only in client-side resource scripts.
* Document paths cannot escape the current resource directory.

[[Category:Client Functions]]
[[Category:GUI Functions]]

GuiHide

QCherry — Tue, 04 Aug 2026 12:44:56 GMT

Automatyczna aktualizacja dokumentacji funkcji

New page

= guiHide =
Hides an RML document without destroying it.

== Syntax ==
<syntaxhighlight lang="lua">
bool guiHide(DocumentHandle document)
</syntaxhighlight>

== Parameters ==
{| class="wikitable"
! Name !! Type !! Required !! Description
|-
| <code>document</code> || <code>DocumentHandle</code> || yes || The document to hide.
|}

== Returns ==
Returns <code>true</code> when the document is hidden; otherwise returns <code>false</code>.

== Examples ==
Temporarily hide a menu:
<syntaxhighlight lang="lua" line>
guiHide(menuDocument)
</syntaxhighlight>

== Notes ==
* Available only in client-side resource scripts.

[[Category:Client Functions]]
[[Category:GUI Functions]]

GuiGetValue

QCherry — Tue, 04 Aug 2026 12:44:55 GMT

Automatyczna aktualizacja dokumentacji funkcji

New page

= guiGetValue =
Reads the value of an element in a loaded RML document.

== Syntax ==
<syntaxhighlight lang="lua">
string guiGetValue(DocumentHandle document, string elementId)
</syntaxhighlight>

== Parameters ==
{| class="wikitable"
! Name !! Type !! Required !! Description
|-
| <code>document</code> || <code>DocumentHandle</code> || yes || The owning document.
|-
| <code>elementId</code> || <code>string</code> || yes || The target element's id attribute.
|}

== Returns ==
Returns the element value as a string, or <code>nil</code> if it cannot be read.

== Examples ==
Read and print a text input:
<syntaxhighlight lang="lua" line>
local message = guiGetValue(chatDocument, "chat-input")
if message then
print(message)
end
</syntaxhighlight>

== Notes ==
* Available only in client-side resource scripts.

[[Category:Client Functions]]
[[Category:GUI Functions]]

GuiFocus

QCherry — Tue, 04 Aug 2026 12:44:53 GMT

Automatyczna aktualizacja dokumentacji funkcji

New page

= guiFocus =
Moves keyboard focus to an element in an RML document.

== Syntax ==
<syntaxhighlight lang="lua">
bool guiFocus(DocumentHandle document, string elementId)
</syntaxhighlight>

== Parameters ==
{| class="wikitable"
! Name !! Type !! Required !! Description
|-
| <code>document</code> || <code>DocumentHandle</code> || yes || The owning document.
|-
| <code>elementId</code> || <code>string</code> || yes || The element that should receive focus.
|}

== Returns ==
Returns <code>true</code> when focus is applied; otherwise returns <code>false</code>.

== Examples ==
Focus the chat input after opening chat:
<syntaxhighlight lang="lua" line>
guiShow(chatDocument)
guiFocus(chatDocument, "chat-input")
</syntaxhighlight>

== Notes ==
* Available only in client-side resource scripts.

[[Category:Client Functions]]
[[Category:GUI Functions]]

GuiClose

QCherry — Tue, 04 Aug 2026 12:44:52 GMT

Automatyczna aktualizacja dokumentacji funkcji

New page

= guiClose =
Closes an RML document and releases its runtime handle.

== Syntax ==
<syntaxhighlight lang="lua">
bool guiClose(DocumentHandle document)
</syntaxhighlight>

== Parameters ==
{| class="wikitable"
! Name !! Type !! Required !! Description
|-
| <code>document</code> || <code>DocumentHandle</code> || yes || The document to close.
|}

== Returns ==
Returns <code>true</code> when the document is closed; otherwise returns <code>false</code>.

== Examples ==
Close a temporary dialog:
<syntaxhighlight lang="lua" line>
guiClose(dialogDocument)
dialogDocument = nil
</syntaxhighlight>

== Notes ==
* Available only in client-side resource scripts.
* Do not use the document handle after it has been closed.

[[Category:Client Functions]]
[[Category:GUI Functions]]

GuiAppendText

QCherry — Tue, 04 Aug 2026 12:44:50 GMT

Automatyczna aktualizacja dokumentacji funkcji

New page

= guiAppendText =
Appends an escaped text entry to an RML element.

== Syntax ==
<syntaxhighlight lang="lua">
bool guiAppendText(DocumentHandle document, string elementId, string text [, string className = "" [, string color = ""]])
</syntaxhighlight>

== Parameters ==
{| class="wikitable"
! Name !! Type !! Required !! Description
|-
| <code>document</code> || <code>DocumentHandle</code> || yes || The owning document.
|-
| <code>elementId</code> || <code>string</code> || yes || The container element's id attribute.
|-
| <code>text</code> || <code>string</code> || yes || The text to append.
|-
| <code>className</code> || <code>string</code> || no || An optional RCSS class for the created entry.
|-
| <code>color</code> || <code>string</code> || no || An optional CSS-compatible text color.
|}

== Returns ==
Returns <code>true</code> when the entry is appended; otherwise returns <code>false</code>.

== Examples ==
Append a colored system message to chat:
<syntaxhighlight lang="lua" line>
guiAppendText(chatDocument, "messages", "Connected to the server", "system", "#9ad17b")
</syntaxhighlight>

== Notes ==
* Available only in client-side resource scripts.

[[Category:Client Functions]]
[[Category:GUI Functions]]

GrantPlayerSpell

QCherry — Tue, 04 Aug 2026 12:44:49 GMT

Automatyczna aktualizacja dokumentacji funkcji

New page

= grantPlayerSpell =
Grants or clears a player spell. This is a readable alias of setPlayerSpellGranted.

== Syntax ==
<syntaxhighlight lang="lua">
bool grantPlayerSpell(int playerId, int|string spell [, bool enabled = true])
</syntaxhighlight>

== Parameters ==
{| class="wikitable"
! Name !! Type !! Required !! Description
|-
| <code>playerId</code> || <code>int</code> || yes || The connected player to update.
|-
| <code>spell</code> || <code>int{{!}}string</code> || yes || A spell id or stable key.
|-
| <code>enabled</code> || <code>bool</code> || no || True to grant the spell, false to revoke it.
|}

== Returns ==
Returns <code>true</code> when the grant state is accepted; otherwise returns <code>false</code>.

== Examples ==
Grant Fire Arrow to a player:
<syntaxhighlight lang="lua" line>
grantPlayerSpell(playerId, SPELL.FIRE_ARROW, true)
</syntaxhighlight>

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

[[Category:Server Functions]]
[[Category:Magic Functions]]
[[Category:Progression Functions]]

GrantPlayerConsumable

QCherry — Tue, 04 Aug 2026 12:44:48 GMT

Automatyczna aktualizacja dokumentacji funkcji

New page

= grantPlayerConsumable =
Grants a supported authoritative consumable item to a player.

== Syntax ==
<syntaxhighlight lang="lua">
bool grantPlayerConsumable(int playerId, string itemKey, int count)
</syntaxhighlight>

== Parameters ==
{| class="wikitable"
! Name !! Type !! Required !! Description
|-
| <code>playerId</code> || <code>int</code> || yes || The connected player receiving the item.
|-
| <code>itemKey</code> || <code>string</code> || yes || A supported consumable key.
|-
| <code>count</code> || <code>int</code> || yes || Quantity from 1 through 100.
|}

== Returns ==
Returns <code>true</code> when the item grant is accepted; otherwise returns <code>false</code>.

== Examples ==
Grant three strong mana potions:
<syntaxhighlight lang="lua" line>
grantPlayerConsumable(playerId, "strong_mana_potion", 3)
</syntaxhighlight>

== Notes ==
* Available only in server-side resource scripts.
* The current implementation supports <code>strong_mana_potion</code>.

[[Category:Server Functions]]
[[Category:Magic Functions]]
[[Category:Progression Functions]]

GivePlayerSkillPoints

QCherry — Tue, 04 Aug 2026 12:44:46 GMT

Automatyczna aktualizacja dokumentacji funkcji

New page

= givePlayerSkillPoints =
Adds an amount to a player's authoritative skill points.

== Syntax ==
<syntaxhighlight lang="lua">
bool givePlayerSkillPoints(int playerId, number amount)
</syntaxhighlight>

== Parameters ==
{| class="wikitable"
! Name !! Type !! Required !! Description
|-
| <code>playerId</code> || <code>int</code> || yes || The connected player to update.
|-
| <code>amount</code> || <code>number</code> || yes || The amount of skill points to add.
|}

== Returns ==
Returns <code>true</code> when the updated value is accepted; otherwise returns <code>false</code>.

== Examples ==
Award skill points to a player:
<syntaxhighlight lang="lua" line>
givePlayerSkillPoints(playerId, 100)
</syntaxhighlight>

== Notes ==
* Available only in server-side resource scripts.
* This is a convenience wrapper around <code>addPlayerStat</code> for <code>skill_points</code>.

[[Category:Server Functions]]
[[Category:Progression Functions]]
[[Category:Player Functions]]

GivePlayerExperience

QCherry — Tue, 04 Aug 2026 12:44:45 GMT

Automatyczna aktualizacja dokumentacji funkcji

New page

= givePlayerExperience =
Adds an amount to a player's authoritative experience.

== Syntax ==
<syntaxhighlight lang="lua">
bool givePlayerExperience(int playerId, number amount)
</syntaxhighlight>

== Parameters ==
{| class="wikitable"
! Name !! Type !! Required !! Description
|-
| <code>playerId</code> || <code>int</code> || yes || The connected player to update.
|-
| <code>amount</code> || <code>number</code> || yes || The amount of experience to add.
|}

== Returns ==
Returns <code>true</code> when the updated value is accepted; otherwise returns <code>false</code>.

== Examples ==
Award experience to a player:
<syntaxhighlight lang="lua" line>
givePlayerExperience(playerId, 100)
</syntaxhighlight>

== Notes ==
* Available only in server-side resource scripts.
* This is a convenience wrapper around <code>addPlayerStat</code> for <code>experience</code>.

[[Category:Server Functions]]
[[Category:Progression Functions]]
[[Category:Player Functions]]