Difference between revisions of "@SpellSuccess"
From SphereWiki
MrSugarCube (talk | contribs) (Created page with '==Description== This trigger fires when a character successfully casts a spell. Fires on: * Characters ==References== The following object references are explicitly avail...') |
(No difference)
|
Revision as of 03:57, 14 June 2009
Description
This trigger fires when a character successfully casts a spell.
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 | I | The spell that was cast. |
| ARGN2 | I | The strength of the spell. |
| LOCAL.CREATEOBJECT1 | O | For field spells, overrides the item BASEID to use for the east-west direction.
For summon spells, overrides the character BASEID to summon. |
| LOCAL.CREATEOBJECT2 | O | For field spells, overrides the item BASEID to use for the north-south direction. |
| LOCAL.FIELDGAUGE | O | For field spells, overrides the default gauge of the field (1). |
| LOCAL.FIELDWIDTH | O | For field spells, overrides the default width of the field (7). |
Return Values
The following return values are explicitly defined for this trigger:
| Return Value | Description |
| 1 | Aborts casting the spell. |
