Difference between revisions of "Enchantment Script"

206 bytes added ,  03:55, 24 October 2013
m
Formatting Change
imported>Cipscis
(Updated links to point to function pages with appropriate names)
imported>CraftySentinel
m (Formatting Change)
Line 21: Line 21:


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


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


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


'''int Function [[GetNthEffectArea - Enchantment|GetNthEffectArea]](int index)'''
|[[GetNthEffectArea - Enchantment|Int '''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 - Enchantment|GetNthEffectDuration]](int index)'''
|[[GetNthEffectDuration - Enchantment|Int '''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 - Enchantment|GetNthEffectMagicEffect]](int index)'''
|[[GetNthEffectMagicEffect - Enchantment|MagicEffect '''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 - Enchantment|GetCostliestEffectIndex]]()'''
|[[GetCostliestEffectIndex - Enchantment|Int '''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