-
Notifications
You must be signed in to change notification settings - Fork 0
@Select_(Spell_Trigger)
This trigger fires when a character selects to cast a spell. It fires multiple times during the different stages of a spell being cast.
Fires on:
The following object references are explicitly available for this trigger:
{| border="1" cellspacing="4" cellpadding="4" | Name || Description |- | ARGO || The source of the spell. Could be the item used to cast the spell (e.g. a wand or scroll) or the character casting the spell. |- | I || The character casting the spell. |- | SRC || The character casting the spell. |}
The following arguments are set for this trigger. If an argument is marked as "In" then a value will be passed in to the trigger, if an argument is marked as "Out" then it can be set to a value to affect Sphere's behaviour:
{| border="1" cellspacing="4" cellpadding="4" | Argument || In/Out || Description |- | ARGN1 || IO || The spell being cast. |- | ARGN2 || IO || The amount of mana needed to cast the spell. |- | ARGN3 || I || Flags representing what stage of the casting process the trigger is being used at.
{| cellpadding="4" | Flag || Meaning |- | 01 || Just a test (no reagents or mana will be consumed) |- | 02 || Display fail message if unable to cast |}
{| cellpadding="4" | Spell Casting Stage || Expected Flags |- | Spell selected for casting || 01 |- | Spell is about to start casting || 03 |- | Spell is about to finish casting || 03 |- | Spell casting finished successfully || 02 |- | Spell casting finished unsuccessfully || 00 |} |}
The following return values are explicitly defined for this trigger:
{| border="1" cellspacing="4" cellpadding="4" | Return Value || Description |- | 0 || Allows the spell to be cast. |- | 1 || Prevents the spell from being cast. |- | 6 || Allows the spell to be cast without checking mana, spellbook, and reagent(s). |}
Category: Reference Compendium Category: Triggers