GetActiveEffectCount
Revision as of 00:59, 27 November 2007 by imported>Haama (→Notes: Better scripted effect info)
A command for Oblivion Script Extender
Syntax:
(count:long) reference.GetActiveEffectCount
Returns the number of Active Effects on the reference.
Example
short NumEffects set NumEffects to player.GetActiveEffectCount
If the player currently has 1 potion with Shield and Restore Health, another potion with Restore Health, and a spell with Shield and Drain Health this will return 5 (2 Shields, 2 Restore Healths, and 1 Drain Health).
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).