Difference between revisions of "Enchantment Script"

From the CreationKit Wiki
Jump to navigation Jump to search
imported>CraftySentinel
m (Formatting Change)
imported>CraftySentinel
m (Reverted to List)
Line 22: Line 22:
== Member Functions ==
== Member Functions ==


{|class="wikitable" width =100%
:'''Bool [[IsHostile - Enchantment|IsHostile]]()'''
!style="text-align:left;"|Function
:*Returns whether this enchantment is considered hostile or not.
!style="text-align:left;"|Description
|-
|[[IsHostile - Enchantment|Bool '''IsHostile'''()]]
|Returns whether this enchantment is considered hostile or not.
|-


|}


== SKSE Member Functions ==
== SKSE Member Functions ==


{|class="wikitable" width =100%
:'''Int [[GetNumEffects - Enchantment|GetNumEffects]]()'''
!style="text-align:left;"|Function
:*Returns the number of effects on this enchantment.
!style="text-align:left;"|Description
|-
|[[GetNumEffects - Enchantment|Int '''GetNumEffects'''()]]
|Returns the number of effects on this enchantment.
|-


|[[GetNthEffectMagnitude - Enchantment|Float '''GetNthEffectMagnitude'''(Int ''index'')]]
:'''Float [[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.
|-


|[[GetNthEffectArea - Enchantment|Int '''GetNthEffectArea'''(Int ''index'')]]
:'''Int [[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.
|-


|[[GetNthEffectDuration - Enchantment|Int '''GetNthEffectDuration'''(Int ''index'')]]
:'''Int [[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.
|-


|[[GetNthEffectMagicEffect - Enchantment|MagicEffect '''GetNthEffectMagicEffect'''(Int ''index'')]]
:'''MagicEffect [[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 [[GetCostliestEffectIndex - Enchantment|GetCostliestEffectIndex]]()'''
:*Returns which effect of the enchantment has the highest cost.


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


|}
== Events ==
== Events ==
None
None

Revision as of 07:04, 2 February 2014


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.


Events

None

Retrieved from "https://ck.uesp.net/w/index.php?title=Enchantment_Script&oldid=9603"