Difference between revisions of "Scroll Script"

From the CreationKit Wiki
Jump to navigation Jump to search
imported>Behippo
(→‎SKSE Member Functions: Added SKSE Member Function list)
imported>Behippo
Line 42: Line 42:


'''int Function [[GetCostliestEffectIndex|GetCostliestEffectIndex]]()'''
'''int Function [[GetCostliestEffectIndex|GetCostliestEffectIndex]]()'''
*Returns which effect of the spell has the highest scroll.
*Returns which effect of the scroll has the highest cost.


== Events ==
== Events ==
None
None

Revision as of 14:50, 10 May 2012


Extends: Form Script

Script for the manipulation of scrolls.

Definition

ScriptName Scroll extends Form

Properties

None

Global Functions

None

Member Functions

Function Cast(ObjectReference akSource, ObjectReference akTarget)

  • Casts this scroll from the source object reference, optionally toward a target object reference.

SKSE Member Functions

float Function GetCastTime()

  • Returns the time to cast the scroll.

int Function GetNumEffects()

  • Returns the number of effects on this scroll.

float Function GetNthEffectMagnitude(int index)

  • Returns the magnitude of the specified effect of this scroll.

int Function GetNthEffectArea(int index)

  • Returns the area of the specified effect of this scroll.

int Function GetNthEffectDuration(int index)

  • Returns the duration of the specified effect of this scroll.

MagicEffect FunctionGetNthEffectMagicEffect(int index)

  • Returns the MagicEffect of the specified effect of this scroll.

int Function GetCostliestEffectIndex()

  • Returns which effect of the scroll has the highest cost.

Events

None