Difference between revisions of "Enchantment Script"

1,679 bytes added ,  02:27, 25 December 2014
→‎SKSE Member Functions: added GetKeywordRestrictions, SetKeywordRestrictions
imported>Jog
imported>Terra Nova2
(→‎SKSE Member Functions: added GetKeywordRestrictions, SetKeywordRestrictions)
 
(9 intermediate revisions by 4 users not shown)
Line 2: Line 2:
[[Category:Papyrus]]
[[Category:Papyrus]]
[[Category:Script Objects]]
[[Category:Script Objects]]
[[Category:SKSE]]
[[Category:SKSE Script Objects]]


'''Extends:''' [[Form Script]]
'''Extends:''' [[Form Script]]
Line 19: Line 21:


== Member Functions ==
== Member Functions ==
'''bool Function [[IsHostile - Enchantment|IsHostile]]()'''
 
*Returns whether this enchantment is considered hostile or not.
:'''Bool [[IsHostile - Enchantment|IsHostile]]()'''
:*Returns whether this enchantment is considered hostile or not.
 
 
== SKSE Member Functions ==
 
:'''Int [[GetNumEffects - Enchantment|GetNumEffects]]()'''
:*Returns the number of effects on this enchantment.
 
:'''Float [[GetNthEffectMagnitude - Enchantment|GetNthEffectMagnitude]](Int ''index'')'''
:*Returns the magnitude of the specified effect of this enchantment.
 
:'''Int [[GetNthEffectArea - Enchantment|GetNthEffectArea]](Int ''index'')'''
:*Returns the area of the specified effect of this enchantment.
 
:'''Int [[GetNthEffectDuration - Enchantment|GetNthEffectDuration]](Int ''index'')'''
:*Returns the duration of the specified effect of this enchantment.
 
:'''MagicEffect [[GetNthEffectMagicEffect - Enchantment|GetNthEffectMagicEffect]](Int ''index'')'''
:*Returns the MagicEffect of the specified effect of this enchantment.
 
:'''Int [[GetCostliestEffectIndex - Enchantment|GetCostliestEffectIndex]]()'''
:*Returns which effect of the enchantment has the highest cost.
 
:'''[[SetNthEffectMagnitude - Enchantment|SetNthEffectMagnitude]](Int ''index'', Float ''value'')'''
:*Sets the magnitude of the specified Effect.
 
:'''[[SetNthEffectArea - Enchantment|SetNthEffectArea]](Int ''index'', Int ''value'')'''
:*Sets the area of the specified Effect.
 
:'''[[SetNthEffectDuration - Enchantment|SetNthEffectDuration]](Int ''index'', Int ''value'')'''
:*Sets the duration of the specified Effect.
 
:'''[[GetBaseEnchantment - Enchantment|GetBaseEnchantment]]()'''
:*Returns the base enchantment of this enchantment
 
:'''Formlist [[GetKeywordRestrictions]]()'''
:*Returns a formlist of keywords.
 
:'''[[SetKeywordRestrictions]](Formlist ''newKeywordList'')'''
:* Sets the formlist of keywords.


== Events ==
== Events ==
None
None
Anonymous user