IsSpellTarget
Revision as of 18:23, 14 January 2009 by imported>JT (→Detecting addictions)
Returns 1 if the calling reference is currently being affected by the specified magic item (an Actor Effect (spell), an Object Effect (enchantment), or an Ingestible (potion)).
Syntax
[ActorRef.]IsSpellTarget MagicID
Example
BuddyRef.IsSpellTarget TrainingMedicineHigh
This will return 1 if Buddy has the specified Actor Ability.
Detecting addictions
If an actor is addicted to a chem, this function will return 1 when the addiction Actor Effect is passed to this function, even when the actor is not presently undergoing withdrawal symptoms. You can use this to detect whether the player is addicted to a substance.
Example:
Player.IsSpellTarget WithdrawalAlcohol
This will return 1 even if the player has recently consumed alcohol and is not presently undergoing withdrawal. It will return 0 for a player who is not addicted to alcohol.