Difference between revisions of "Scroll Script"

211 bytes added ,  05:26, 24 October 2013
m
Formatting Change
imported>Cipscis
(Updated links to point to function pages with appropriate names)
imported>CraftySentinel
m (Formatting Change)
Line 19: Line 19:


== Member Functions ==
== Member Functions ==
'''Function [[Cast - Scroll|Cast]](ObjectReference akSource, ObjectReference akTarget)'''
 
*Casts this scroll from the source object reference, optionally toward a target object reference.
{|class="wikitable" width =100%
!style="text-align:left;"|Function
!style="text-align:left;"|Description
|-
|[[Cast - Scroll|'''Cast'''(ObjectReference ''akSource'', ObjectReference ''akTarget'')]]
|Casts this scroll from the source object reference, optionally toward a target object reference.
|-
 
|}


== SKSE Member Functions ==
== SKSE Member Functions ==
'''float Function [[GetCastTime - Scroll|GetCastTime]]()'''
*Returns the time to cast the scroll.


'''int Function [[GetNumEffects - Scroll|GetNumEffects]]()'''
{|class="wikitable" width =100%
*Returns the number of effects on this scroll.
!style="text-align:left;"|Function
!style="text-align:left;"|Description
|-
|[[GetCastTime - Scroll|Float '''GetCastTime'''()]]
|Returns the time to cast the scroll.
|-
 
|[[GetNumEffects - Scroll|Int '''GetNumEffects'''()]]
|Returns the number of effects on this scroll.
|-
 
|[[GetNthEffectMagnitude - Scroll|Float '''GetNthEffectMagnitude'''(Int ''index'')]]
|Returns the magnitude of the specified effect of this scroll.
|-


'''float Function [[GetNthEffectMagnitude - Scroll|GetNthEffectMagnitude]](int index)'''
|[[GetNthEffectArea - Scroll|Int '''GetNthEffectArea'''(Int ''index'')]]
*Returns the magnitude of the specified effect of this scroll.
|Returns the area of the specified effect of this scroll.
|-


'''int Function [[GetNthEffectArea - Scroll|GetNthEffectArea]](int index)'''
|[[GetNthEffectDuration - Scroll|Int '''GetNthEffectDuration'''(Int ''index'')]]
*Returns the area of the specified effect of this scroll.
|Returns the duration of the specified effect of this scroll.
|-


'''int Function [[GetNthEffectDuration - Scroll|GetNthEffectDuration]](int index)'''
|[[GetNthEffectMagicEffect - Scroll|MagicEffect '''GetNthEffectMagicEffect'''(Int ''index'')]]
*Returns the duration of the specified effect of this scroll.
|Returns the MagicEffect of the specified effect of this scroll.
|-


'''MagicEffect Function[[GetNthEffectMagicEffect - Scroll|GetNthEffectMagicEffect]](int index)'''
|[[GetCostliestEffectIndex - Scroll|Int '''GetCostliestEffectIndex'''()]]
*Returns the MagicEffect of the specified effect of this scroll.
|Returns which effect of the scroll has the highest cost.
|-


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


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