View source for GivePlayerSpell

= 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 Bolt to a player:
<syntaxhighlight lang="lua" line>
givePlayerSpell(playerId, SPELL.fire_bolt)
</syntaxhighlight>

== Notes ==
* Available only in server-side resource scripts.
* 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:Server Functions]]
[[Category:Magic Functions]]
[[Category:Progression Functions]]