Difference between revisions of "Scroll Script"

From the CreationKit Wiki
Jump to navigation Jump to search
imported>CraftySentinel
(→‎SKSE Member Functions: Added SKSE Member functions should now contain all SKSE functions upto 1.06.16)
 
(3 intermediate revisions by 2 users not shown)
Line 20: Line 20:
== Member Functions ==
== Member Functions ==


{|class="wikitable" width =100%
:'''[[Cast - Scroll|Cast]](ObjectReference ''akSource'', ObjectReference ''akTarget'')'''
!style="text-align:left;"|Function
:*Casts this scroll from the source object reference, optionally toward a target object reference.
!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%
:'''Float [[GetCastTime - Scroll|GetCastTime]]()'''
!style="text-align:left;"|Function
:*Returns the time to cast the scroll.
!style="text-align:left;"|Description
|-


|[[GetCastTime - Scroll|Float '''GetCastTime'''()]]
:'''Perk [[GetPerk - Scroll|GetPerk]]()'''
|Returns the time to cast the scroll.
:*Returns the perk associated with the spell.
|-


|[[GetPerk - Scroll|Perk '''GetPerk'''()]]
:'''Int [[GetNumEffects - Scroll|GetNumEffects]]()'''
|Returns the perk associated with the spell.
:*Returns the number of effects on this scroll.
|-


|[[GetNumEffects - Scroll|Int '''GetNumEffects'''()]]
:'''Float [[GetNthEffectMagnitude - Scroll|GetNthEffectMagnitude]](Int ''index'')'''
|Returns the number of effects on this scroll.
:*Returns the magnitude of the specified effect of this scroll.
|-


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


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


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


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


|[[GetCostliestEffectIndex - Scroll|Int '''GetCostliestEffectIndex'''()]]
:'''[[SetNthEffectMagnitude - Spell|SetNthEffectMagnitude]](Int ''index'', Float ''value'')'''
|Returns which effect of the scroll has the highest cost.
:*Sets the magnitude of the specified effect of this scroll.
|-


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


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


|[[SetNthEffectDuration - Scroll|Int '''SetNthEffectDuration'''(Int ''index'', int ''value'')]]
:'''EquipSlot [[GetEquipType - Scroll|GetEquipType]]()'''
|Set the duration of the specified effect of this scroll.
:*Returns the equip slot type of the scroll.
|-


|[[GetEquipType - Scroll|EquipSlot '''GetEquipType'''()]]
:'''[[SetEquipType - Scroll|SetEquipType]](EquipSlot ''type'')'''
|Returns the equip slot type of the scroll.
:*Sets the equip slot type of the scroll to the specified amount.
|-


|[[SetEquipType - Scroll|'''GetEquipType'''(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 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

Retrieved from "https://ck.uesp.net/w/index.php?title=Scroll_Script&oldid=23278"