Difference between revisions of "@SpellEffectTick"
From SphereWiki
| (4 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
==Description== | ==Description== | ||
| − | This trigger fires when a character | + | This trigger fires when a character is under effect of a periodic spell (like Poison 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. | | [[I]] || The object that is going to be affected. | ||
|- | |- | ||
| [[SRC]] || The object that is going to be affected. | | [[SRC]] || The object that is going to be affected. | ||
| − | + | |- | |
| + | | ARGO || The spell memory.(Argo.link holds the caster UID) | ||
|} | |} | ||
| Line 27: | Line 29: | ||
|- | |- | ||
| ARGN2 || IO || Spell Level | | ARGN2 || IO || Spell Level | ||
| − | |||
| − | |||
|- | |- | ||
| 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.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. | ||
| Line 38: | Line 38: | ||
| 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. | | 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== | ||
Latest revision as of 21:54, 4 January 2023
Description
This trigger fires when a character is under effect of a periodic spell (like Poison 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. |
| ARGO | The spell memory.(Argo.link holds the caster UID) |
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 |
| 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 Values
The following return values are explicitly defined for this trigger:
| Return Value | Description |
| 1 | Destroy the spell memory and block the spell execution. |
| 0 | If the spell has the flag SPELLFLAG_SCRIPTED blocks the spell execution |
