Table of Contents

Class EnchantmentScript

Namespace
SkyrimForge.Papyrus
Assembly
SkyrimForge.Game.dll

Functions and comments from Enchantment.psc.

public static class EnchantmentScript
Inheritance
EnchantmentScript
Inherited Members

Properties

Dispatcher

The dispatcher that binds this script to a form and calls the functions and properties that have no generated member.

public static PapyrusScriptDispatcher Dispatcher { get; }

Property Value

PapyrusScriptDispatcher

Methods

GetBaseEnchantment(PapyrusScript<Enchantment>)

returns the base enchantment of this enchantment

public static Task<Enchantment?> GetBaseEnchantment(this PapyrusScript<Enchantment> self)

Parameters

self PapyrusScript<Enchantment>

Returns

Task<Enchantment?>

GetCostliestEffectIndex(PapyrusScript<Enchantment>)

return the index of the costliest effect

public static Task<int> GetCostliestEffectIndex(this PapyrusScript<Enchantment> self)

Parameters

self PapyrusScript<Enchantment>

Returns

Task<int>

GetKeywordRestrictions(PapyrusScript<Enchantment>)

Returns a Formlist of Keywords

public static Task<FormList?> GetKeywordRestrictions(this PapyrusScript<Enchantment> self)

Parameters

self PapyrusScript<Enchantment>

Returns

Task<FormList?>

GetNthEffectArea(PapyrusScript<Enchantment>, int)

return the area of the specified effect

public static Task<int> GetNthEffectArea(this PapyrusScript<Enchantment> self, int index)

Parameters

self PapyrusScript<Enchantment>
index int

Returns

Task<int>

GetNthEffectDuration(PapyrusScript<Enchantment>, int)

return the duration of the specified effect

public static Task<int> GetNthEffectDuration(this PapyrusScript<Enchantment> self, int index)

Parameters

self PapyrusScript<Enchantment>
index int

Returns

Task<int>

GetNthEffectMagicEffect(PapyrusScript<Enchantment>, int)

return the magic effect of the specified effect

public static Task<MagicEffect?> GetNthEffectMagicEffect(this PapyrusScript<Enchantment> self, int index)

Parameters

self PapyrusScript<Enchantment>
index int

Returns

Task<MagicEffect?>

GetNthEffectMagnitude(PapyrusScript<Enchantment>, int)

return the magnitude of the specified effect

public static Task<float> GetNthEffectMagnitude(this PapyrusScript<Enchantment> self, int index)

Parameters

self PapyrusScript<Enchantment>
index int

Returns

Task<float>

GetNumEffects(PapyrusScript<Enchantment>)

SKSE64 additions built 2024-01-17 20:01:40.731000 UTC return the number of the effects

public static Task<int> GetNumEffects(this PapyrusScript<Enchantment> self)

Parameters

self PapyrusScript<Enchantment>

Returns

Task<int>

IsHostile(PapyrusScript<Enchantment>)

Is this enchantment classified as hostile?

public static Task<bool> IsHostile(this PapyrusScript<Enchantment> self)

Parameters

self PapyrusScript<Enchantment>

Returns

Task<bool>

SetKeywordRestrictions(PapyrusScript<Enchantment>, FormList)

Sets the FormList of keywords

public static Task SetKeywordRestrictions(this PapyrusScript<Enchantment> self, FormList newKeywordList)

Parameters

self PapyrusScript<Enchantment>
newKeywordList FormList

Returns

Task

SetNthEffectArea(PapyrusScript<Enchantment>, int, int)

sets the area of the specified effect

public static Task SetNthEffectArea(this PapyrusScript<Enchantment> self, int index, int value)

Parameters

self PapyrusScript<Enchantment>
index int
value int

Returns

Task

SetNthEffectDuration(PapyrusScript<Enchantment>, int, int)

sets the duration of the specified effect

public static Task SetNthEffectDuration(this PapyrusScript<Enchantment> self, int index, int value)

Parameters

self PapyrusScript<Enchantment>
index int
value int

Returns

Task

SetNthEffectMagnitude(PapyrusScript<Enchantment>, int, float)

sets the magnitude of the specified effect

public static Task SetNthEffectMagnitude(this PapyrusScript<Enchantment> self, int index, float value)

Parameters

self PapyrusScript<Enchantment>
index int
value float

Returns

Task