GetNthActiveEffectDuration

From the Oblivion ConstructionSet Wiki
Revision as of 19:49, 1 March 2008 by imported>DragoonWraith (AE function)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

A command for Oblivion Script Extender

Syntax:

(duration:long)  reference.GetNthActiveEffectDuration whichEffect:long
(duration:long)  reference.GetNthAEDuration whichEffect:long

Returns the duration of the Nth Active Effect on the reference.

Example

short EffectDur
set EffectDur to (player.GetNthActiveEffectDuration 0)

If the player currently has two Shield effects, the first at 10 duration and the second at 90, this will return 10.

Notes

  • Active Effects from different sources are counted as unique Active Effects, even if they are the same. For example, a Shield effect from a potion, a Shield effect from another potion, and a Shield effect from a spell, each one will return their own magnitude.
    • If the Magic Item has 2 of the same effect, they will be counted separately.
    • If the effect is from the same Magic Item (i.e., 2 instances of DrinkAle), it will still count as 2 separate Active Effects.
      • While counted separately, if there are multiple scripted effects with the same script generally only the first one's data (i.e., Magic Item Index, Caster) will be returned (i.e., GetNthActiveEffectMagicItemIndex, GetNthActiveEffectCaster).

See Also