Editing OnSpellCast - ObjectReference

[[Category:Scripting]]
[[Category:Papyrus]]
[[Category:Events]]
'''Member of:''' [[ObjectReference Script]]

Event called when a spell is cast by this object reference.

== Syntax ==
<syntaxhighlight lang="papyrus">
Event OnSpellCast(Form akSpell)
</syntaxhighlight>

== Parameters ==
*akSpell: Spell that was cast.  Can be [[Spell Script | Spell]], [[Enchantment Script | Enchantment]], [[Potion Script | Potion]], or [[Ingredient Script | Ingredient]].

== Examples ==
<syntaxhighlight lang="papyrus">
Spell Property FireballSpell Auto ; Our fireball spell object that we can compare our argument to

Event OnSpellCast(Form akSpell)
  Spell spellCast = akSpell as Spell
  if spellCast == FireballSpell
    Debug.Trace("We just cast a fireball!")
  else
    Debug.Trace("We cast something, but we don't know what it is")
  endIf
endEvent
</syntaxhighlight>

== Notes ==
*For concentration spells, this event only fires once, at the moment the reference begins casting.
*This function does not appear to detect spells cast via Papyrus (e.g. TempleBlessingScript casts its spell on the player from the player, but the event is not caught).
* This Event can also be used to detect shouts cast by the player, but unlike spells, akSpell must be assigned to a shout.

== See Also ==
*[[ObjectReference Script]]