Difference between revisions of "Enchantment Script"

From the CreationKit Wiki
Jump to navigation Jump to search
imported>PurpleLunchbox
imported>Cipscis
(Updated links to point to function pages with appropriate names)
Line 25: Line 25:


== SKSE Member Functions ==
== SKSE Member Functions ==
'''int Function [[GetNumEffects|GetNumEffects]]()'''
'''int Function [[GetNumEffects - Enchantment|GetNumEffects]]()'''
*Returns the number of effects on this enchantment.
*Returns the number of effects on this enchantment.


'''float Function [[GetNthEffectMagnitude|GetNthEffectMagnitude]](int index)'''
'''float Function [[GetNthEffectMagnitude - Enchantment|GetNthEffectMagnitude]](int index)'''
*Returns the magnitude of the specified effect of this enchantment.
*Returns the magnitude of the specified effect of this enchantment.


'''int Function [[GetNthEffectArea|GetNthEffectArea]](int index)'''
'''int Function [[GetNthEffectArea - Enchantment|GetNthEffectArea]](int index)'''
*Returns the area of the specified effect of this enchantment.
*Returns the area of the specified effect of this enchantment.


'''int Function [[GetNthEffectDuration|GetNthEffectDuration]](int index)'''
'''int Function [[GetNthEffectDuration - Enchantment|GetNthEffectDuration]](int index)'''
*Returns the duration of the specified effect of this enchantment.
*Returns the duration of the specified effect of this enchantment.


'''MagicEffect Function [[GetNthEffectMagicEffect|GetNthEffectMagicEffect]](int index)'''
'''MagicEffect Function [[GetNthEffectMagicEffect - Enchantment|GetNthEffectMagicEffect]](int index)'''
*Returns the MagicEffect of the specified effect of this enchantment.
*Returns the MagicEffect of the specified effect of this enchantment.


'''int Function [[GetCostliestEffectIndex|GetCostliestEffectIndex]]()'''
'''int Function [[GetCostliestEffectIndex - Enchantment|GetCostliestEffectIndex]]()'''
*Returns which effect of the enchantment has the highest cost.
*Returns which effect of the enchantment has the highest cost.


== Events ==
== Events ==
None
None

Revision as of 15:52, 5 September 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