@SpellEffect - Revision history

Lightsource: /* Arguments */

2017-04-06T02:08:12Z

‎Arguments

Darksun84: /* Arguments */

2015-06-16T15:12:45Z

‎Arguments

Darksun84: /* Arguments */

2015-06-16T15:12:18Z

‎Arguments

XuN: /* Arguments */

2015-05-06T10:17:02Z

‎Arguments

RanXerox: /* Arguments */ added an example

2013-08-26T19:58:04Z

‎Arguments: added an example

RanXerox: /* Arguments */

2013-08-26T19:54:49Z

‎Arguments

Anubis: /* Arguments */

2013-07-20T19:54:22Z

‎Arguments

MrSugarCube: Created page with '==Description== This trigger fires when an object is hit by the effects of a spell. The object may have been targeted directly or it may have been hit by an area-effect spell. ...'

2009-06-13T12:28:25Z

Created page with '==Description== This trigger fires when an object is hit by the effects of a spell. The object may have been targeted directly or it may have been hit by an area-effect spell. ...'

New page

==Description==
This trigger fires when an object is hit by the effects of a spell. The object may have been targeted directly or it may have been hit by an area-effect spell.

Fires on:
* [[Characters]]
* [[Items]]

==References==
The following object references are explicitly available for this trigger:

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Description'''
|-
| [[ARGO]] || The [[Items|item]] used to cast the spell (e.g. a wand or scroll).
|-
| [[I]] || The [[Characters|character]] or [[Items|item]] being hit by the spell.
|-
| [[SRC]] || The [[Characters|character]] responsible for 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:

{| border="1" cellspacing="4" cellpadding="4"
| '''Argument''' || '''In/Out''' || '''Description'''
|-
| ARGN1 || IO || The number of the spell that has hit the object.
|-
| ARGN2 || IO || The strength of the spell.
|-
| ARGN3 || IO || A multiplier for the spell's duration or effect.<br />'''Note:''' Only used when a character is hit by a spell.
|}

==Return Values==
The following return values are explicitly defined for this trigger:

{| border="1" cellspacing="4" cellpadding="4"
| '''Return Value''' || '''Description'''
|-
| 0 || For scripted spells, prevents any hardcoded behaviour from taking place.
|-
| 1 || Prevents the object from being affected by the spell.
|}

'''Note:''' For the recall and gate travel spells, returning 0 prevents the spell from proceeding and returning 1 has no effect.

[[Category: Reference Compendium]]
[[Category: Triggers]]

@@ Line 47: / Line 47: @@
 |-
 | local.EffectExplode || IO || Sets wether the effect should explode or not after reaching the target.
 |}

@@ Line 40: / Line 40: @@
 | LOCAL.AreaRadius || IO || Can be used to override the default radius (which is 5) for spells that have SPELLFLAG_AREA.
 |-
-| Local.CreateObject1 || IO || Changes the ID of the effect for this spell, IE: local.EffectID=0eed in FlameStrike spell will change the Fire Column for a Gold Coin.
+| Local.CreateObject1 || IO || Changes the ID of the effect for this spell, IE: Local.CreateObject1=0eed in FlameStrike spell will change the Fire Column for a Gold Coin.
 |-
 | local.EffectColor || IO || Changes the color of the effect for this spell.

@@ Line 40: / Line 40: @@
 | LOCAL.AreaRadius || IO || Can be used to override the default radius (which is 5) for spells that have SPELLFLAG_AREA.
 |-
-| local.EffectID || IO || Changes the ID of the effect for this spell, IE: local.EffectID=0eed in FlameStrike spell will change the Fire Column for a Gold Coin.
+| Local.CreateObject1 || IO || Changes the ID of the effect for this spell, IE: local.EffectID=0eed in FlameStrike spell will change the Fire Column for a Gold Coin.
 |-
 | local.EffectColor || IO || Changes the color of the effect for this spell.

@@ Line 39: / Line 39: @@
 |-
 | LOCAL.AreaRadius || IO || Can be used to override the default radius (which is 5) for spells that have SPELLFLAG_AREA.
 |}

@@ Line 34: / Line 34: @@
 | ARGN3 || IO || A multiplier for the spell's duration or effect.<br />'''Note:''' Only used when a character is hit by a spell.
 |-
-| LOCAL.DamageType || IO || Can be used to override the damage flags for spells that have SPELLFLAG_DAMAGE.  The value can be a bitmask of dam_* flags.
+| LOCAL.DamageType || IO || Can be used to override the damage flags for spells that have SPELLFLAG_DAMAGE.  The value can be a bitmask of dam_* flags.  For example, to change the s_magic_arrow SPELL definition to cause physical and magic damage:
 |-
 | LOCAL.AreaRadius || IO || Can be used to override the default radius (which is 5) for spells that have SPELLFLAG_AREA.

@@ Line 33: / Line 33: @@
 |-
 | ARGN3 || IO || A multiplier for the spell's duration or effect.<br />'''Note:''' Only used when a character is hit by a spell.
 |}
 ==Return Values==