Difference between revisions of "IsSpellTarget"
imported>JT (tested -- is not working for Ingestibles (contrary to article before my edits)) |
imported>JT (→Ingestibles: clarification of purpose) |
||
| Line 22: | Line 22: | ||
=== Ingestibles === | === Ingestibles === | ||
Unfortunately, this function does not detect whether you are under the influence of a particular [[Ingestible]] (potion, chem, food item, etc.). | Unfortunately, this function does not detect whether you are under the influence of a particular [[Ingestible]] (potion, chem, food item, etc.). Thus, while you may detect whether the player is addicted to something, you cannot detect whether the player has recently sated their addiction using this function. (It may still be possible to use [[HasMagicEffect]] on a custom base effect specified in the ingestible.) | ||
== See Also == | == See Also == | ||
Revision as of 19:42, 14 January 2009
Returns 1 if the calling reference is currently being affected by the specified magic item (an Actor Effect (spell) or an Object Effect (enchantment)).
Syntax
[ActorRef.]IsSpellTarget MagicID
Example
BuddyRef.IsSpellTarget TrainingMedicineHigh
This will return 1 if Buddy has the specified Actor Ability.
Notes
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.
Ingestibles
Unfortunately, this function does not detect whether you are under the influence of a particular Ingestible (potion, chem, food item, etc.). Thus, while you may detect whether the player is addicted to something, you cannot detect whether the player has recently sated their addiction using this function. (It may still be possible to use HasMagicEffect on a custom base effect specified in the ingestible.)