Difference between revisions of "Scroll Script"
Jump to navigation
Jump to search
imported>PurpleLunchbox |
imported>Cipscis (Updated links to point to function pages with appropriate names) |
||
| Line 23: | Line 23: | ||
== SKSE Member Functions == | == SKSE Member Functions == | ||
'''float Function [[GetCastTime|GetCastTime]]()''' | '''float Function [[GetCastTime - Scroll|GetCastTime]]()''' | ||
*Returns the time to cast the scroll. | *Returns the time to cast the scroll. | ||
'''int Function [[GetNumEffects|GetNumEffects]]()''' | '''int Function [[GetNumEffects - Scroll|GetNumEffects]]()''' | ||
*Returns the number of effects on this scroll. | *Returns the number of effects on this scroll. | ||
'''float Function [[GetNthEffectMagnitude|GetNthEffectMagnitude]](int index)''' | '''float Function [[GetNthEffectMagnitude - Scroll|GetNthEffectMagnitude]](int index)''' | ||
*Returns the magnitude of the specified effect of this scroll. | *Returns the magnitude of the specified effect of this scroll. | ||
'''int Function [[GetNthEffectArea|GetNthEffectArea]](int index)''' | '''int Function [[GetNthEffectArea - Scroll|GetNthEffectArea]](int index)''' | ||
*Returns the area of the specified effect of this scroll. | *Returns the area of the specified effect of this scroll. | ||
'''int Function [[GetNthEffectDuration|GetNthEffectDuration]](int index)''' | '''int Function [[GetNthEffectDuration - Scroll|GetNthEffectDuration]](int index)''' | ||
*Returns the duration of the specified effect of this scroll. | *Returns the duration of the specified effect of this scroll. | ||
'''MagicEffect Function[[GetNthEffectMagicEffect|GetNthEffectMagicEffect]](int index)''' | '''MagicEffect Function[[GetNthEffectMagicEffect - Scroll|GetNthEffectMagicEffect]](int index)''' | ||
*Returns the MagicEffect of the specified effect of this scroll. | *Returns the MagicEffect of the specified effect of this scroll. | ||
'''int Function [[GetCostliestEffectIndex|GetCostliestEffectIndex]]()''' | '''int Function [[GetCostliestEffectIndex - Scroll|GetCostliestEffectIndex]]()''' | ||
*Returns which effect of the scroll has the highest cost. | *Returns which effect of the scroll has the highest cost. | ||
== Events == | == Events == | ||
None | None | ||
Revision as of 15:53, 5 September 2012
Extends: Form Script
Script for the manipulation of scrolls.
Definition
ScriptName Scroll extends FormProperties
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