GivePlayerSpell - Revision history

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

2026-08-27T11:36:36Z

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: givePlayerSpell. -->~~
	= givePlayerSpell =		= givePlayerSpell =
	Grants or clears a player's authoritative spell ownership state.		Grants or clears a player's authoritative spell ownership state.
Line 23:		Line 22:

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

Line 31:		Line 30:
	* Available only in server-side resource scripts.		* Available only in server-side resource scripts.
	* This is an alias of <code>setPlayerSpellGranted</code>.		* This is an alias of <code>setPlayerSpellGranted</code>.
			* Grant state and cast support are separate. See [[Synchronized spell catalog]] and check <code>getSpellDefinition(spell).implemented</code> before exposing a spell to players.

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

QCherry: Complete Lua function catalog

2026-08-15T09:53:54Z

Complete Lua function catalog

← Older revision		Revision as of 09:53, 15 August 2026
Line 32:		Line 32:
	* This is an alias of <code>setPlayerSpellGranted</code>.		* This is an alias of <code>setPlayerSpellGranted</code>.

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

QCherry: Automatyczna aktualizacja dokumentacji funkcji

2026-08-05T20:13:30Z

Automatyczna aktualizacja dokumentacji funkcji

New page

= givePlayerSpell =
Grants or clears a player's authoritative spell ownership state.

== Syntax ==
<syntaxhighlight lang="lua">
bool givePlayerSpell(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 identifier.
|-
| <code>spell</code> || <code>int{{!}}string</code> || yes || A spell id, a stable spell key, or a value from the global SPELL table.
|-
| <code>enabled</code> || <code>bool</code> || no || True to grant the spell or false to revoke it; defaults to true.
|}

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

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

== Notes ==
* Available only in server-side resource scripts.
* This is an alias of <code>setPlayerSpellGranted</code>.

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