QCherry: Update Lua event reference

2026-08-14T22:32:19Z

Update Lua event reference

New page

= onPlayerSpellEquip =
Triggered when the authoritative equipped or in-hand state of a spell changes.

== Availability ==
This event is available in '''server-side''' scripts.

== Callback signature ==
<syntaxhighlight lang="lua">
onPlayerSpellEquip(playerId, spellKey, spellId, spellLevel, equipped, inHand)
</syntaxhighlight>

== Parameters ==
{| class="wikitable"
! Name !! Type !! Description
|-
| <code>playerId</code> || <code>int</code> || The player changing spell equipment.
|-
| <code>spellKey</code> || <code>string</code> || The stable spell definition key.
|-
| <code>spellId</code> || <code>int</code> || The numeric spell ID.
|-
| <code>spellLevel</code> || <code>int</code> || The spell level reported by the client and validated by the server.
|-
| <code>equipped</code> || <code>bool</code> || Whether the spell is equipped.
|-
| <code>inHand</code> || <code>bool</code> || Whether the spell is currently held for casting.
|}

== Examples ==
Handle the event:
<syntaxhighlight lang="lua" line>
addEventHandler("onPlayerSpellEquip", root, function(playerId, spellKey, spellId, spellLevel, equipped, inHand)
outputDebugString(getPlayerName(playerId) .. " spell " .. spellKey .. " inHand=" .. tostring(inHand))
end)
</syntaxhighlight>

[[Category:Lua Events]]
[[Category:Server Events]]
[[Category:Magic Events]]

OnPlayerSpellEquip - Revision history

QCherry: Update Lua event reference