Difference between revisions of "Enchantment Script"

From the CreationKit Wiki
Jump to navigation Jump to search
imported>Jog
imported>Behippo
(→‎Member Functions: Added SKSE Member Function list)
Line 21: Line 21:
'''bool Function [[IsHostile - Enchantment|IsHostile]]()'''
'''bool Function [[IsHostile - Enchantment|IsHostile]]()'''
*Returns whether this enchantment is considered hostile or not.
*Returns whether this enchantment is considered hostile or not.
== SKSE Member Functions ==
'''int Function [[GetNumEffects|GetNumEffects]]()'''
*Returns the number of effects on this enchantment.
'''float Function [[[GetNthEffectMagnitude|GetNthEffectMagnitude]](int index)'''
*Returns the magnitude of the specified effect of this enchantment.
'''int Function [[GetNthEffectArea|GetNthEffectArea]](int index)'''
*Returns the area of the specified effect of this enchantment.
'''int Function [[GetNthEffectDuration|GetNthEffectDuration]](int index)'''
*Returns the duration of the specified effect of this enchantment.
'''MagicEffect Function[[GetNthEffectMagicEffect|GetNthEffectMagicEffect]](int index)'''
*Returns the MagicEffect of the specified effect of this enchantment.
'''int Function [[GetCostliestEffectIndex|GetCostliestEffectIndex]]()'''
*Returns which effect of the enchantment has the highest cost.


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

Revision as of 01:31, 10 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|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 FunctionGetNthEffectMagicEffect(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