Difference between revisions of "Enchantment Script"
Jump to navigation
Jump to search
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 == | ||
''' | |||
*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 | ||
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 FormProperties[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