Difference between revisions of "GetNthActiveEffectMagnitude"

references are optional, at least in Object scripts...
imported>Haama
(→‎Notes: More on how Active Effects stack)
imported>DragoonWraith
(references are optional, at least in Object scripts...)
 
(2 intermediate revisions by 2 users not shown)
Line 2: Line 2:


'''Syntax:'''
'''Syntax:'''
  (magnitude:long)  reference.GetNthActiveEffectMagnitude whichEffect:long
  (magnitude:long)  ''reference.''GetNthActiveEffectMagnitude whichEffect:long
  (magnitude:long)  reference.GetNthAEMagnitude whichEffect:long
  (magnitude:long)  ''reference.''GetNthAEMagnitude whichEffect:long


Returns the magnitude of the Nth Active Effect on the reference.
Returns the magnitude of the Nth Active Effect on the reference.
Line 19: Line 19:
**If the Magic Item has 2 of the same effect, they will be counted separately.
**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.
**If the effect is from the same Magic Item (i.e., 2 instances of DrinkAle), it will still count as 2 separate Active Effects.
***The only exception is scripted effects with the same script. Generally, only the first one's data (Magic Item Index, Caster, etc.) will be used.
***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==
==See Also==
Line 41: Line 41:
[[Category:Magic Functions]]
[[Category:Magic Functions]]
[[Category:Magic Functions (OBSE)]]
[[Category:Magic Functions (OBSE)]]
[[Category:Magic Functions - Active Effect (OBSE)]]