GetLastRunScriptEffect()

From NWN Lexicon
Jump to: navigation, search
Nwnee logo.jpg Note: This article documents Neverwinter Nights: Enhanced Edition new content or changes/updates/fixes to 1.69 functions. These are all listed under the category and patches pages.

Get the effect that last triggered an EffectRunScript() script.

effect GetLastRunScriptEffect();

Description

Get the effect that last triggered an EffectRunScript() script.

Note: This can be used to get the creator or tag, among others, of the EffectRunScript() in one of its scripts.

Returns an effect of type EFFECT_TYPE_INVALIDEFFECT when called outside of an EffectRunScript() script.

Note that in the RUNSCRIPT_EFFECT_SCRIPT_TYPE_ON_APPLIED event, that the effect GetLastRunScriptEffect has not yet really been applied (it won't appear in a check of effects using GetFirstEffect) so some effect checking functions like GetEffectDurationRemaining won't work.


Remarks

This returns a valid effect on the sOnRemovedScript (and removing it via a RemoveEffect call doesn't fire the script again).

Use this to correctly assign who is applying further effects (for instance damage), or any number of other things such as getting the effect tag, the effect sData component etc.


Version

This function was added in 1.84.8193.29 of NWN:EE.


Example

See EffectRunScript for a full example.


See Also

functions:

EffectRunScript GetLastRunScriptEffectScriptType