Difference between revisions of "Enchantment Script"

From the CreationKit Wiki
Jump to navigation Jump to search
imported>CraftySentinel
m (Formatting Change)
imported>Terra Nova2
(→‎SKSE Member Functions: added GetKeywordRestrictions, SetKeywordRestrictions)
 
(2 intermediate revisions by one other user not shown)
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.
|-


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

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"