RUNSCRIPT_EFFECT_SCRIPT_TYPE_* Constant Group

From NWN Lexicon
Revision as of 15:50, 18 July 2021 by Jasperre (talk | contribs) (Jasperre moved page Runscript effect script type to RUNSCRIPT EFFECT SCRIPT TYPE: Capitalised)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigationJump to search

Constants used to specify which event of EffectRunScript was called when calling GetLastRunScriptEffectScriptType.

Note the default return value of the function in error is 0, an invalid RUNSCRIPT_EFFECT_SCRIPT_TYPE_* value.

Constants

Constant Value Description
RUNSCRIPT_EFFECT_SCRIPT_TYPE_ON_APPLIED 1 When sOnAppliedScript is fired.
RUNSCRIPT_EFFECT_SCRIPT_TYPE_ON_INTERVAL 3 When sOnIntervalScript is fired.
RUNSCRIPT_EFFECT_SCRIPT_TYPE_ON_REMOVED 2 When sOnRemovedScript is fired. Note if the object the effect is applied to is destroyed (via. DestroyObject or other means the game/DM uses) then this script will not fire.


Version

This constants group was added in 1.84.8193.29 of NWN:EE.


See Also

functions: EffectRunScript, GetLastRunScriptEffectScriptType