Difference between revisions of "@SpellFail"

From SphereWiki
Jump to: navigation, search
(Created page with '==Description== This trigger fires when a character fails to cast a spell. Fires on: * Characters ==References== The following object references are explicitly available ...')
 
(Add New sphere X argument to the trigger)
 
Line 28: Line 28:
 
|-
 
|-
 
| ARGN1 || I || The spell that was being cast.
 
| ARGN1 || I || The spell that was being cast.
 +
|}
 +
 +
The following arguments are use only in the X version:
 +
 +
{| border="1" cellspacing="4" cellpadding="4"
 +
| '''Argument''' || '''In/Out''' || '''Description'''
 +
|-
 +
| ARGN2 || IO || The mana loss if the spell is failed.
 +
|-
 +
| local.tithingloss || IO || The tithing points loss if the spell is failed.
 +
While both are writeable, they only works if  ManaLossFail or ReagentLossFail ( also for tithing points) are enabled in the sphere.ini
 
|}
 
|}
  

Latest revision as of 16:23, 30 March 2021

Description

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


Fires on:


References

The following object references are explicitly available for this trigger:

Name Description
ARGO The item used to cast the spell (e.g. a wand or scroll).
I The character failing to cast the spell.
SRC The character failing to cast 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 being cast.

The following arguments are use only in the X version:

Argument In/Out Description
ARGN2 IO The mana loss if the spell is failed.
local.tithingloss IO The tithing points loss if the spell is failed.

While both are writeable, they only works if ManaLossFail or ReagentLossFail ( also for tithing points) are enabled in the sphere.ini


Return Values

The following return values are explicitly defined for this trigger:

Return Value Description
1 Prevents normal fail behaviours (fail message, fizzle effect, reagent loss).