Difference between revisions of "Scroll Script"
Jump to navigation
Jump to search
imported>Jlundin |
|||
| (10 intermediate revisions by 6 users not shown) | |||
| Line 19: | Line 19: | ||
== Member Functions == | == Member Functions == | ||
:'''[[Cast - Scroll|Cast]](ObjectReference ''akSource'', ObjectReference ''akTarget'')''' | |||
:*Casts this scroll from the source object reference, optionally toward a target object reference. | |||
== SKSE Member Functions == | |||
:'''Float [[GetCastTime - Scroll|GetCastTime]]()''' | |||
:*Returns the time to cast the scroll. | |||
:'''Perk [[GetPerk - Scroll|GetPerk]]()''' | |||
:*Returns the perk associated with the spell. | |||
:'''Int [[GetNumEffects - Scroll|GetNumEffects]]()''' | |||
:*Returns the number of effects on this scroll. | |||
:'''Float [[GetNthEffectMagnitude - Scroll|GetNthEffectMagnitude]](Int ''index'')''' | |||
:*Returns the magnitude of the specified effect of this scroll. | |||
:'''Int [[GetNthEffectArea - Scroll|GetNthEffectArea]](Int ''index'')''' | |||
:*Returns the area of the specified effect of this scroll. | |||
:'''Int [[GetNthEffectDuration - Scroll|GetNthEffectDuration]](Int ''index'')''' | |||
:*Returns the duration of the specified effect of this scroll. | |||
:'''MagicEffect [[GetNthEffectMagicEffect - Scroll|GetNthEffectMagicEffect]](Int ''index'')''' | |||
:*Returns the MagicEffect of the specified effect of this scroll. | |||
:'''Int [[GetCostliestEffectIndex - Scroll|GetCostliestEffectIndex]]()''' | |||
:*Returns which effect of the scroll has the highest cost. | |||
:'''[[SetNthEffectMagnitude - Spell|SetNthEffectMagnitude]](Int ''index'', Float ''value'')''' | |||
:*Sets the magnitude of the specified effect of this scroll. | |||
:'''[[SetNthEffectArea - Spell|SetNthEffectArea]](Int ''index'', Int ''value'')''' | |||
:*Sets the area of the specified effect of this scroll. | |||
:'''[[SetNthEffectDuration - Spell|SetNthEffectDuration]](Int ''index'', int ''value'')''' | |||
:*Set the duration of the specified effect of this scroll. | |||
:'''EquipSlot [[GetEquipType - Scroll|GetEquipType]]()''' | |||
:*Returns the equip slot type of the scroll. | |||
:'''[[SetEquipType - Scroll|SetEquipType]](EquipSlot ''type'')''' | |||
:*Sets the equip slot type of the scroll to the specified amount. | |||
== Events == | == Events == | ||
None | None | ||
Latest revision as of 07:35, 14 September 2023
Extends: Form Script
Script for the manipulation of scrolls.
Definition[edit | edit source]
ScriptName Scroll extends FormProperties[edit | edit source]
None
Global Functions[edit | edit source]
None
Member Functions[edit | edit source]
- Cast(ObjectReference akSource, ObjectReference akTarget)
- Casts this scroll from the source object reference, optionally toward a target object reference.
SKSE Member Functions[edit | edit source]
- 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.
- SetEquipType(EquipSlot type)
- Sets the equip slot type of the scroll to the specified amount.
Events[edit | edit source]
None