Difference between revisions of "Scroll Script"

From the CreationKit Wiki
Jump to navigation Jump to search
imported>CraftySentinel
m (→‎SKSE Member Functions: Typo I missed... whoops)
imported>Egocarib
(updated links)
Line 69: Line 69:
|-
|-


|[[SetNthEffectMagnitude - Scroll|'''SetNthEffectMagnitude'''(Int ''index'', Float ''value'')]]
|[[SetNthEffectMagnitude - Spell|'''SetNthEffectMagnitude'''(Int ''index'', Float ''value'')]]
|Sets the magnitude of the specified effect of this scroll.
|Sets the magnitude of the specified effect of this scroll.
|-
|-


|[[SetNthEffectArea - Scroll|'''SetNthEffectArea'''(Int ''index'', Int ''value'')]]
|[[SetNthEffectArea - Spell|'''SetNthEffectArea'''(Int ''index'', Int ''value'')]]
|Sets the area of the specified effect of this scroll.
|Sets the area of the specified effect of this scroll.
|-
|-


|[[SetNthEffectDuration - Scroll|'''SetNthEffectDuration'''(Int ''index'', int ''value'')]]
|[[SetNthEffectDuration - Spell|'''SetNthEffectDuration'''(Int ''index'', int ''value'')]]
|Set the duration of the specified effect of this scroll.
|Set the duration of the specified effect of this scroll.
|-
|-

Revision as of 23:57, 20 November 2013


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.
Perk GetPerk() Returns the perk associated with the spell.
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.
SetNthEffectMagnitude(Int index, Float value) Sets the magnitude of the specified effect of this scroll.
SetNthEffectArea(Int index, Int value) Sets the area of the specified effect of this scroll.
SetNthEffectDuration(Int index, int value) Set the duration of the specified effect of this scroll.
EquipSlot GetEquipType() Returns the equip slot type of the scroll.
GetEquipType(EquipSlot type) Sets the equip slot type of the scroll to the specified amount.

Events

None