Difference between revisions of "GetNthActiveEffectData"
Jump to navigation
Jump to search
imported>Haama (Created) |
imported>DragoonWraith (AE function) |
||
| (3 intermediate revisions by one other user not shown) | |||
| Line 5: | Line 5: | ||
(data:ref) reference.GetNthAEData whichEffect:long | (data:ref) reference.GetNthAEData whichEffect:long | ||
Return the data of the Nth Active Effect on the reference. | Return the data of the Nth Active Effect on the reference. Data includes things like a summoned creature, weapon or armor. | ||
==Notes== | ==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. | *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== | ==See Also== | ||
| Line 29: | Line 29: | ||
[[Category:Magic Functions]] | [[Category:Magic Functions]] | ||
[[Category:Magic Functions (OBSE)]] | [[Category:Magic Functions (OBSE)]] | ||
[[Category:Magic Functions - Active Effect (OBSE)]] | |||
Latest revision as of 20:49, 1 March 2008
A command for Oblivion Script Extender
Syntax:
(data:ref) reference.GetNthActiveEffectData whichEffect:long (data:ref) reference.GetNthAEData whichEffect:long
Return the data of the Nth Active Effect on the reference. Data includes things like a summoned creature, weapon or armor.
Notes[edit | edit source]
- 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).