Scroll Script

From the CreationKit Wiki
Revision as of 05:26, 24 October 2013 by imported>CraftySentinel (Formatting Change)
Jump to navigation Jump to search


Extends: Form Script

Script for the manipulation of scrolls.

Definition

ScriptName Scroll extends Form

Properties

None

Global Functions

None

Member Functions

Function Description
Cast(ObjectReference akSource, ObjectReference akTarget) Casts this scroll from the source object reference, optionally toward a target object reference.

SKSE Member Functions

Function Description
Float GetCastTime() Returns the time to cast the scroll.
Int GetNumEffects() Returns the number of effects on this scroll.
Float GetNthEffectMagnitude(Int index) Returns the magnitude of the specified effect of this scroll.
Int GetNthEffectArea(Int index) Returns the area of the specified effect of this scroll.
Int GetNthEffectDuration(Int index) Returns the duration of the specified effect of this scroll.
MagicEffect GetNthEffectMagicEffect(Int index) Returns the MagicEffect of the specified effect of this scroll.
Int GetCostliestEffectIndex() Returns which effect of the scroll has the highest cost.

Events

None