Enchantment Script

From Creation Kit
Jump to: navigation, search


Extends: Form Script

Script for the manipulation of enchantment base objects.

Definition

ScriptName Enchantment extends Form

Properties

None

Global Functions

None

Member Functions

Bool IsHostile()
  • Returns whether this enchantment is considered hostile or not.


SKSE Member Functions

Int GetNumEffects()
  • Returns the number of effects on this enchantment.
Float GetNthEffectMagnitude(Int index)
  • Returns the magnitude of the specified effect of this enchantment.
Int GetNthEffectArea(Int index)
  • Returns the area of the specified effect of this enchantment.
Int GetNthEffectDuration(Int index)
  • Returns the duration of the specified effect of this enchantment.
MagicEffect GetNthEffectMagicEffect(Int index)
  • Returns the MagicEffect of the specified effect of this enchantment.
Int GetCostliestEffectIndex()
  • Returns which effect of the enchantment has the highest cost.
SetNthEffectMagnitude(Int index, Float value)
  • Sets the magnitude of the specified Effect.
SetNthEffectArea(Int index, Int value)
  • Sets the area of the specified Effect.
SetNthEffectDuration(Int index, Int value)
  • Sets the duration of the specified Effect.
GetBaseEnchantment()
  • Returns the base enchantment of this enchantment
Formlist GetKeywordRestrictions()
  • Returns a formlist of keywords.
SetKeywordRestrictions(Formlist newKeywordList)
  • Sets the formlist of keywords.

Events

None