Difference between revisions of "Enchantment Script"
Jump to navigation
Jump to search
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 == | ||
{|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 == | ||
''' | {|class="wikitable" width =100% | ||
!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. | |||
|- | |||
|[[GetNthEffectArea - Enchantment|Int '''GetNthEffectArea'''(Int ''index'')]] | |||
|Returns the area of the specified effect of this enchantment. | |||
|- | |||
|[[GetNthEffectDuration - Enchantment|Int '''GetNthEffectDuration'''(Int ''index'')]] | |||
|Returns the duration of the specified effect of this enchantment. | |||
|- | |||
|[[GetNthEffectMagicEffect - Enchantment|MagicEffect '''GetNthEffectMagicEffect'''(Int ''index'')]] | |||
|Returns the MagicEffect of the specified effect of this enchantment. | |||
|- | |||
|[[GetCostliestEffectIndex - Enchantment|Int '''GetCostliestEffectIndex'''()]] | |||
|Returns which effect of the enchantment has the highest cost. | |||
|- | |||
|} | |||
== Events == | == Events == | ||
None | None | ||
Revision as of 03:55, 24 October 2013
Extends: Form Script
Script for the manipulation of enchantment base objects.
Definition
ScriptName Enchantment extends FormProperties
None
Global Functions
None
Member Functions
| Function | Description |
|---|---|
| Bool IsHostile() | Returns whether this enchantment is considered hostile or not. |
SKSE Member Functions
| Function | Description |
|---|---|
| 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. |
Events
None