Difference between revisions of "GetNthActiveEffectCode"

From the Oblivion ConstructionSet Wiki
Jump to navigation Jump to search
imported>Haama
(Fixed example)
imported>Haama
(Notes)
Line 11: Line 11:
  set EffectCode to (player.GetNthActiveEffectCode 0)
  set EffectCode to (player.GetNthActiveEffectCode 0)
If the player currently has the effects '''Shield''', '''Restore Health''', and '''Shield''', in that order, this will return the code for '''Shield''' (code for '''Restore Health''' if whichEffect is 1, and code for '''Shield''' if whichEffect is 2).
If the player currently has the effects '''Shield''', '''Restore Health''', and '''Shield''', in that order, this will return the code for '''Shield''' (code for '''Restore Health''' if whichEffect is 1, and code for '''Shield''' if whichEffect is 2).
==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
**#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?
**#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.)


==See Also==
==See Also==

Revision as of 23:50, 25 November 2007

A command for Oblivion Script Extender

Syntax:

(effectCode:long) reference.GetNthActiveEffectCode whichEffect:long
(effectCode:long) reference.GetNthAECode whichEffect:long

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

Example

long EffectCode
set EffectCode to (player.GetNthActiveEffectCode 0)

If the player currently has the effects Shield, Restore Health, and Shield, in that order, this will return the code for Shield (code for Restore Health if whichEffect is 1, and code for Shield if whichEffect is 2).

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
      1. 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?
      2. 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.)

See Also