Difference between revisions of "Enchantment Script"

From the CreationKit Wiki
Jump to navigation Jump to search
imported>PurpleLunchbox
imported>Terra Nova2
(→‎SKSE Member Functions: added GetKeywordRestrictions, SetKeywordRestrictions)
 
(6 intermediate revisions by 3 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 ==
== SKSE Member Functions ==
'''int Function [[GetNumEffects|GetNumEffects]]()'''
*Returns the number of effects on this enchantment.


'''float Function [[GetNthEffectMagnitude|GetNthEffectMagnitude]](int index)'''
:'''Int [[GetNumEffects - Enchantment|GetNumEffects]]()'''
*Returns the magnitude of the specified effect of this enchantment.
:*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.


'''int Function [[GetNthEffectArea|GetNthEffectArea]](int index)'''
:'''[[SetNthEffectDuration - Enchantment|SetNthEffectDuration]](Int ''index'', Int ''value'')'''
*Returns the area of the specified effect of this enchantment.
:*Sets the duration of the specified Effect.


'''int Function [[GetNthEffectDuration|GetNthEffectDuration]](int index)'''
:'''[[GetBaseEnchantment - Enchantment|GetBaseEnchantment]]()'''
*Returns the duration of the specified effect of this enchantment.
:*Returns the base enchantment of this enchantment


'''MagicEffect Function [[GetNthEffectMagicEffect|GetNthEffectMagicEffect]](int index)'''
:'''Formlist [[GetKeywordRestrictions]]()'''
*Returns the MagicEffect of the specified effect of this enchantment.
:*Returns a formlist of keywords.


'''int Function [[GetCostliestEffectIndex|GetCostliestEffectIndex]]()'''
:'''[[SetKeywordRestrictions]](Formlist ''newKeywordList'')'''
*Returns which effect of the enchantment has the highest cost.
:* Sets the formlist of keywords.


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

Latest revision as of 01:27, 25 December 2014


Extends: Form Script

Script for the manipulation of enchantment base objects.

Definition[edit | edit source]

ScriptName Enchantment extends Form

Properties[edit | edit source]

None

Global Functions[edit | edit source]

None

Member Functions[edit | edit source]

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


SKSE Member Functions[edit | edit source]

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[edit | edit source]

None

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