Difference between revisions of "GetNthActiveEffectCaster"

Latest revision as of 19:48, 1 March 2008

Syntax:

(caster:ref) reference.GetNthActiveEffectCaster whichEffect:long
(caster:ref) reference.GetNthAECaster whichEffect:long

Return the caster of the Nth Active Effect on the reference.

Example

ref pCaster
set pCaster to (player.GetNthActiveEffectCaster 0)

If an NPC cast Shield on the player (and it's the first Active Effect), this will return the reference of the NPC.

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).

@@ Line 14: / Line 14: @@
 ==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.
-**Untested
+**If the Magic Item has 2 of the same effect, they will be counted separately.
-**#Do effects from the same source stack into one? That is, if a potion has 2 '''Shield''' effects, will there be 2 Active Effects, each with their own magnitude?
+**If the effect is from the same Magic Item (i.e., 2 instances of DrinkAle), it will still count as 2 separate Active Effects.
-**#Will the same spell stack? That is, if you cast a '''Shield''' spell on an NPC twice, will there be 2 Active Effects or 1? (If spells don't work that way, potions can be stacked multiple times on the player by applying it as a poison.)
+***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==
@@ Line 34: / Line 34: @@
 [[Category:Magic Functions]]
 [[Category:Magic Functions (OBSE)]]
+[[Category:Magic Functions - Active Effect (OBSE)]]