@EffectRemove

From SphereWiki
Jump to: navigation, search

Description

This trigger fires when a spell memory item is removed (and after the @Destroy trigger of the item).


Fires on:


References

The following object references are explicitly available for this trigger:

Name Description
ARGO The memory item.
I The character affected by the effect.
SRC The 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:

Argument In/Out Description
ARGN1 I The spell ID

Return Values

The following return values are explicitly defined for this trigger:

Return Value Description
0 prevents default spell behaviour be executed when the spell item get removed. This is necessary when return 0 is used in @EffectAdd of the same spell.

For Summoning spells, returning 0 in @EffectRemove will prevent the summon to disappear.


Note: Poisoning spells are not affected by this trigger