Difference between revisions of "AddEffectItem"

From the Oblivion ConstructionSet Wiki
Jump to navigation Jump to search
imported>WereWolf
imported>Haama
(Added example, notes on Effects index)
Line 5: Line 5:


Adds a basic, empty EffectItem of the specified MagicEffect to the magic item.
Adds a basic, empty EffectItem of the specified MagicEffect to the magic item.
'''Example'''
short EffectIndex
set EffectIndex to (AddEffectItem DSPL DrinkAle)
Adds a Dispel effect of 0 Magnitude and 0 Duration to the item DrinkAle (Ale), and sets EffectIndex to 3. Ale has 3 effects already, making this the 4th effect. The effects index starts from 0, such that 0 is the 1st effect, 1 the 2nd, 2 the 3rd, and 3 the 4th.


==Notes==
==Notes==
Line 11: Line 16:
* Potions will only show up to 8 effects, but all of the effects will still apply when used, and can be accessed with any '''GetNthEffectItem...''' function.
* Potions will only show up to 8 effects, but all of the effects will still apply when used, and can be accessed with any '''GetNthEffectItem...''' function.
** Untested for other magic items.
** Untested for other magic items.
* Effects index starts from 0, such that 0 is the 1st effect, 1 the 2nd...


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

Revision as of 19:13, 3 October 2007

A command for Oblivion Script Extender

Syntax:

(index:short) AddEffectItem nuEffect:chars magicItem:ref

Adds a basic, empty EffectItem of the specified MagicEffect to the magic item.

Example

short EffectIndex
set EffectIndex to (AddEffectItem DSPL DrinkAle)

Adds a Dispel effect of 0 Magnitude and 0 Duration to the item DrinkAle (Ale), and sets EffectIndex to 3. Ale has 3 effects already, making this the 4th effect. The effects index starts from 0, such that 0 is the 1st effect, 1 the 2nd, 2 the 3rd, and 3 the 4th.

Notes

  • Uses the 4 letter codes for the magic effects listed in the CS.
  • Magic items include Potions, Ingredients, Spells and Enchantments. They do not include Sigil Stones or Soulgems. Also note that the Enchantment refers to the base enchantment. If the enchantment is on two items changing it on one item will change it on the other.
  • Potions will only show up to 8 effects, but all of the effects will still apply when used, and can be accessed with any GetNthEffectItem... function.
    • Untested for other magic items.
  • Effects index starts from 0, such that 0 is the 1st effect, 1 the 2nd...

See Also