Difference between revisions of "IsSpellTarget"
Jump to navigation
Jump to search
redacted: my test was faulty -- IsSpellTarget [ingestible] works great!; attempted to compensate for mistake and commensurate loss of e-peen =P
imported>JT (→Ingestibles: clarification of purpose) |
imported>JT (redacted: my test was faulty -- IsSpellTarget [ingestible] works great!; attempted to compensate for mistake and commensurate loss of e-peen =P) |
||
| Line 1: | Line 1: | ||
Returns 1 if the calling reference is currently being affected by the specified magic item (an [[Actor Effect]] (spell) | 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]] (drug, potion, chem)). | ||
== Syntax == | == Syntax == | ||
| Line 20: | Line 20: | ||
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. | 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. | ||
=== | === Detecting satiation of addictions == | ||
You can also detect whether the player is under the influence of the chem itself to determine whether the player has sated their addiction or not. This isn't compatible across mods, unfortunately, because you need to check all of the chemical types directly, but is still quite handy. | |||
'''Example:''' | |||
if Player.IsSpellTarget WithdrawalAlcohol > 0 | |||
if Player.IsSpellTarget Beer > 0 || Player.IsSpellTarget Scotch > 0 || Player.IsSpellTarget Wine > 0 || Player.IsSpellTarget Whiskey > 0 || Player.IsSpellTarget Vodka > 0 | |||
;Display a message of satisfaction | |||
... | |||
else | |||
;Display a message of anguish | |||
... | |||
endif | |||
else | |||
;Display a message of purity and serenity | |||
... | |||
endif | |||
== See Also == | == See Also == | ||