@Start (Spell Trigger)

From SphereWiki
Revision as of 23:59, 19 June 2009 by MrSugarCube (talk | contribs) (Created page with '==Description== This trigger fires when a character begins to cast a spell. Fires on: * Spells ==References== The following object references are explicitly availab...')
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Description

This trigger fires when a character begins to cast a spell.


Fires on:


References

The following object references are explicitly available for this trigger:

Name Description
ARGO The item being used to cast the spell (e.g. a wand or scroll).
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 number being cast.
ARGN2 IO The difficulty of the spell.
ARGN3 IO The length of time it will take to cast the spell, in tenths of a second.


Return Values

The following return values are explicitly defined for this trigger:

Return Value Description
1 Prevents the spell from being cast.