Difference between revisions of "@Select (Spell Trigger)"
From SphereWiki
MrSugarCube (talk | contribs) (Created page with '==Description== 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: * [[SPELL|Spel...') |
m (→Return Values: Clarification on the purpose for return 6) |
||
| Line 67: | Line 67: | ||
| 1 || Prevents the spell from being cast. | | 1 || Prevents the spell from being cast. | ||
|- | |- | ||
| − | | 6 || Allows the spell to be cast. | + | | 6 || Allows the spell to be cast without checking mana, spellbook, and reagent(s). |
|} | |} | ||
Latest revision as of 22:42, 31 July 2011
Description
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:
References
The following object references are explicitly available for this trigger:
| 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. |
Arguments
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:
| 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.
|
Return Values
The following return values are explicitly defined for this trigger:
| 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). |
