Difference between revisions of "Scroll Script"
Jump to navigation
Jump to search
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 == | ||
{|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 == | ||
''' | {|class="wikitable" width =100% | ||
!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. | |||
|- | |||
|[[GetNthEffectArea - Scroll|Int '''GetNthEffectArea'''(Int ''index'')]] | |||
|Returns the area of the specified effect of this scroll. | |||
|- | |||
|[[GetNthEffectDuration - Scroll|Int '''GetNthEffectDuration'''(Int ''index'')]] | |||
|Returns the duration of the specified effect of this scroll. | |||
|- | |||
|[[GetNthEffectMagicEffect - Scroll|MagicEffect '''GetNthEffectMagicEffect'''(Int ''index'')]] | |||
|Returns the MagicEffect of the specified effect of this scroll. | |||
|- | |||
|[[GetCostliestEffectIndex - Scroll|Int '''GetCostliestEffectIndex'''()]] | |||
|Returns which effect of the scroll has the highest cost. | |||
|- | |||
|} | |||
== Events == | == Events == | ||
None | None | ||
Revision as of 05:26, 24 October 2013
Extends: Form Script
Script for the manipulation of scrolls.
Definition
ScriptName Scroll extends FormProperties
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