Difference between revisions of "Enchantment Script"

From the CreationKit Wiki
Jump to navigation Jump to search
imported>PurpleLunchbox
imported>PurpleLunchbox
Line 2: Line 2:
[[Category:Papyrus]]
[[Category:Papyrus]]
[[Category:Script Objects]]
[[Category:Script Objects]]
[[Category:SKSE]]


'''Extends:''' [[Form Script]]
'''Extends:''' [[Form Script]]

Revision as of 22:02, 13 May 2012


Extends: Form Script

Script for the manipulation of enchantment base objects.

Definition

ScriptName Enchantment extends Form

Properties

None

Global Functions

None

Member Functions

bool Function IsHostile()

  • Returns whether this enchantment is considered hostile or not.

SKSE Member Functions

int Function GetNumEffects()

  • Returns the number of effects on this enchantment.

float Function GetNthEffectMagnitude(int index)

  • Returns the magnitude of the specified effect of this enchantment.

int Function GetNthEffectArea(int index)

  • Returns the area of the specified effect of this enchantment.

int Function GetNthEffectDuration(int index)

  • Returns the duration of the specified effect of this enchantment.

MagicEffect Function GetNthEffectMagicEffect(int index)

  • Returns the MagicEffect of the specified effect of this enchantment.

int Function GetCostliestEffectIndex()

  • Returns which effect of the enchantment has the highest cost.

Events

None