Class ScrollScript

Namespace

SkyrimForge.Papyrus

Assembly

SkyrimForge.Game.dll

Functions and comments from Scroll.psc.

public static class ScrollScript

Inheritance

object

ScrollScript

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

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

Cast(PapyrusScript<Scroll>, IObjectReference, IObjectReference?)

Cast this scroll from an ObjectReference, optionally toward another.

public static Task Cast(this PapyrusScript<Scroll> self, IObjectReference akSource, IObjectReference? akTarget = null)

Parameters

self PapyrusScript<Scroll>

akSource IObjectReference

akTarget IObjectReference

Returns

Task

GetCastTime(PapyrusScript<Scroll>)

SKSE64 additions built 2024-01-17 20:01:40.731000 UTC return the casting time

public static Task<float> GetCastTime(this PapyrusScript<Scroll> self)

Parameters

self PapyrusScript<Scroll>

Returns

Task<float>

GetCostliestEffectIndex(PapyrusScript<Scroll>)

return the index of the costliest effect

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

Parameters

self PapyrusScript<Scroll>

Returns

Task<int>

GetEffectAreas(PapyrusScript<Scroll>)

Returns all the areas of this object in order

public static Task<int[]> GetEffectAreas(this PapyrusScript<Scroll> self)

Parameters

self PapyrusScript<Scroll>

Returns

Task<int[]>

GetEffectDurations(PapyrusScript<Scroll>)

Returns all the durations of this object in order

public static Task<int[]> GetEffectDurations(this PapyrusScript<Scroll> self)

Parameters

self PapyrusScript<Scroll>

Returns

Task<int[]>

GetEffectMagnitudes(PapyrusScript<Scroll>)

Returns all the magnitudes of this object in order

public static Task<float[]> GetEffectMagnitudes(this PapyrusScript<Scroll> self)

Parameters

self PapyrusScript<Scroll>

Returns

Task<float[]>

GetEquipType(PapyrusScript<Scroll>)

public static Task<EquipSlot?> GetEquipType(this PapyrusScript<Scroll> self)

Parameters

self PapyrusScript<Scroll>

Returns

Task<EquipSlot?>

GetMagicEffects(PapyrusScript<Scroll>)

Returns all the magic effects of this object in order

public static Task<MagicEffect[]> GetMagicEffects(this PapyrusScript<Scroll> self)

Parameters

self PapyrusScript<Scroll>

Returns

Task<MagicEffect[]>

GetNthEffectArea(PapyrusScript<Scroll>, int)

return the area of the specified effect

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

Parameters

self PapyrusScript<Scroll>

index int

Returns

Task<int>

GetNthEffectDuration(PapyrusScript<Scroll>, int)

return the duration of the specified effect

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

Parameters

self PapyrusScript<Scroll>

index int

Returns

Task<int>

GetNthEffectMagicEffect(PapyrusScript<Scroll>, int)

return the magic effect of the specified effect

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

Parameters

self PapyrusScript<Scroll>

index int

Returns

Task<MagicEffect?>

GetNthEffectMagnitude(PapyrusScript<Scroll>, int)

return the magnitude of the specified effect

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

Parameters

self PapyrusScript<Scroll>

index int

Returns

Task<float>

GetNumEffects(PapyrusScript<Scroll>)

return the number of the effects

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

Parameters

self PapyrusScript<Scroll>

Returns

Task<int>

GetPerk(PapyrusScript<Scroll>)

return the perk associated with the spell

public static Task<Perk?> GetPerk(this PapyrusScript<Scroll> self)

Parameters

self PapyrusScript<Scroll>

Returns

Task<Perk?>

SetEquipType(PapyrusScript<Scroll>, EquipSlot)

public static Task SetEquipType(this PapyrusScript<Scroll> self, EquipSlot type)

Parameters

self PapyrusScript<Scroll>

type EquipSlot

Returns

Task

SetNthEffectArea(PapyrusScript<Scroll>, int, int)

sets the area of the specified effect

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

Parameters

self PapyrusScript<Scroll>

index int

value int

Returns

Task

SetNthEffectDuration(PapyrusScript<Scroll>, int, int)

sets the duration of the specified effect

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

Parameters

self PapyrusScript<Scroll>

index int

value int

Returns

Task

SetNthEffectMagnitude(PapyrusScript<Scroll>, int, float)

sets the magnitude of the specified effect

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

Parameters

self PapyrusScript<Scroll>

index int

value float

Returns

Task