Difference between revisions of "@SpellEffectTick"
From SphereWiki
| Line 1: | Line 1: | ||
==Description== | ==Description== | ||
| − | + | This trigger fires when a character successfully casts a spell. | |
| Line 12: | Line 12: | ||
{| border="1" cellspacing="4" cellpadding="4" | {| border="1" cellspacing="4" cellpadding="4" | ||
| '''Name''' || '''Description''' | | '''Name''' || '''Description''' | ||
| + | | [[I]] || The object that is going to be affected. | ||
|- | |- | ||
| − | | [[ | + | | [[SRC]] || The object that is going to be affected. |
| − | + | ||
| − | |||
| − | |||
| − | |||
|} | |} | ||
| Line 26: | Line 24: | ||
| '''Argument''' || '''In/Out''' || '''Description''' | | '''Argument''' || '''In/Out''' || '''Description''' | ||
|- | |- | ||
| − | | ARGN1 || I || | + | | ARGN1 || I || Spell Id |
|- | |- | ||
| − | | ARGN2 || IO || | + | | ARGN2 || IO || Spell Level |
|- | |- | ||
| − | | | + | | ARGO || IO || The spell memory.(Argo.link holds the caster UID) |
| − | |||
| − | |||
|- | |- | ||
| − | | LOCAL. | + | | LOCAL.CHARGES || IO || How many charges are left on the spell memory, this will be automatically decreased by 1 at the end of the method execution. Default value is 1. |
|- | |- | ||
| − | | LOCAL. | + | | LOCAL.DELAY || IO || How many seconds until the next spell effect tick. Default value is 5 seconds. |
|- | |- | ||
| − | | LOCAL. | + | | LOCAL.EFFECT || IO || The effect value of the spell, harmful or beneficial (if SPELLFLAG_HEAL is enabled). |
|- | |- | ||
| − | | LOCAL. | + | | LOCAL.DAMAGETYPE || IO || The damage type of the spell, if you are making a custom spell you must set a value otherwise the spell will not cause damage. |
| − | + | ||
==Return Values== | ==Return Values== | ||
| Line 49: | Line 45: | ||
| '''Return Value''' || '''Description''' | | '''Return Value''' || '''Description''' | ||
|- | |- | ||
| − | | 1 || | + | | 1 || Destroy the spell memory and block the spell execution. |
| + | | '''Return Value''' || '''Description''' | ||
| + | |- | ||
| + | | 0 || If the spell has the flag SPELLFLAG_SCRIPTED blocks the spell execution | ||
| + | |||
| + | |||
|} | |} | ||
Revision as of 01:47, 23 September 2022
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 | I | The object that is going to be affected. |
| SRC | The object that is going to be affected. |
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 | Spell Id | ||||||||
| ARGN2 | IO | Spell Level | ||||||||
| ARGO | IO | The spell memory.(Argo.link holds the caster UID) | ||||||||
| LOCAL.CHARGES | IO | How many charges are left on the spell memory, this will be automatically decreased by 1 at the end of the method execution. Default value is 1. | ||||||||
| LOCAL.DELAY | IO | How many seconds until the next spell effect tick. Default value is 5 seconds. | ||||||||
| LOCAL.EFFECT | IO | The effect value of the spell, harmful or beneficial (if SPELLFLAG_HEAL is enabled). | ||||||||
| LOCAL.DAMAGETYPE | IO | The damage type of the spell, if you are making a custom spell you must set a value otherwise the spell will not cause damage.
Return ValuesThe following return values are explicitly defined for this trigger:
|
