QCherry: Update Lua event reference

2026-08-14T22:32:13Z

Update Lua event reference

New page

= onPlayerSpellCastComplete =
Triggered when an authoritative spell cast completes.

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

== Callback signature ==
<syntaxhighlight lang="lua">
onPlayerSpellCastComplete(playerId, spellKey, spellId, castId, phase, result, rejectReason, targetPlayerId, phaseStartTimeMs, phaseDurationMs, manaAfter)
</syntaxhighlight>

== Parameters ==
{| class="wikitable"
! Name !! Type !! Description
|-
| <code>playerId</code> || <code>int</code> || The casting player ID.
|-
| <code>spellKey</code> || <code>string</code> || The stable spell definition key.
|-
| <code>spellId</code> || <code>int</code> || The numeric spell ID.
|-
| <code>castId</code> || <code>int</code> || The unique cast sequence ID for this player.
|-
| <code>phase</code> || <code>string</code> || The authoritative cast phase.
|-
| <code>result</code> || <code>string</code> || The authoritative phase result.
|-
| <code>rejectReason</code> || <code>string</code> || The rejection reason, or an empty value when accepted.
|-
| <code>targetPlayerId</code> || <code>int</code> || The selected target player ID, if any.
|-
| <code>phaseStartTimeMs</code> || <code>int</code> || Server time at which the phase began.
|-
| <code>phaseDurationMs</code> || <code>int</code> || Expected duration of the phase in milliseconds.
|-
| <code>manaAfter</code> || <code>number</code> || Authoritative mana after this transition.
|}

== Examples ==
Handle the event:
<syntaxhighlight lang="lua" line>
addEventHandler("onPlayerSpellCastComplete", root, function(playerId, spellKey, spellId, castId, phase, result, rejectReason, targetPlayerId, phaseStartTimeMs, phaseDurationMs, manaAfter)
outputDebugString("onPlayerSpellCastComplete: " .. spellKey .. " cast=" .. castId .. " phase=" .. phase)
end)
</syntaxhighlight>

== Notes ==
* Use <code>castId</code> to correlate all phases, projectiles, impacts, and cleanup for one cast.

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

OnPlayerSpellCastComplete - Revision history

QCherry: Update Lua event reference