Difference between revisions of "Scroll Script"

From the CreationKit Wiki
Jump to navigation Jump to search
imported>PurpleLunchbox
 
(6 intermediate revisions by 3 users not shown)
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.
:'''[[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|GetCastTime]]()'''
*Returns the time to cast the scroll.


'''int Function [[GetNumEffects|GetNumEffects]]()'''
:'''Float [[GetCastTime - Scroll|GetCastTime]]()'''
*Returns the number of effects on this scroll.
:*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.


'''float Function [[GetNthEffectMagnitude|GetNthEffectMagnitude]](int index)'''
:'''[[SetNthEffectDuration - Spell|SetNthEffectDuration]](Int ''index'', int ''value'')'''
*Returns the magnitude of the specified effect of this scroll.
:*Set the duration of the specified effect of this scroll.


'''int Function [[GetNthEffectArea|GetNthEffectArea]](int index)'''
:'''EquipSlot [[GetEquipType - Scroll|GetEquipType]]()'''
*Returns the area of the specified effect of this scroll.
:*Returns the equip slot type of the scroll.


'''int Function [[GetNthEffectDuration|GetNthEffectDuration]](int index)'''
:'''[[SetEquipType - Scroll|SetEquipType]](EquipSlot ''type'')'''
*Returns the duration of the specified effect of this scroll.
:*Sets the equip slot type of the scroll to the specified amount.


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


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


== 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 Form

Properties[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