Editing
Scroll Script
Jump to navigation
Jump to search
Warning:
You are not logged in. Your IP address will be publicly visible if you make any edits. If you
log in
or
create an account
, your edits will be attributed to your username, along with other benefits.
Anti-spam check. Do
not
fill this in!
[[Category:Scripting]] [[Category:Papyrus]] [[Category:Script Objects]] '''Extends:''' [[Form Script]] Script for the manipulation of scrolls. == Definition == <syntaxhighlight lang="papyrus"> ScriptName Scroll extends Form </syntaxhighlight> == Properties == None == Global Functions == None == 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 == None
Summary:
Please note that all contributions to the CreationKit Wiki are considered to be released under the Creative Commons Attribution-ShareAlike (see
CreationKit:Copyrights
for details). If you do not want your writing to be edited mercilessly and redistributed at will, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource.
Do not submit copyrighted work without permission!
Cancel
Editing help
(opens in new window)
Navigation menu
Personal tools
Not logged in
Talk
Contributions
Create account
Log in
Namespaces
Page
Discussion
English
Views
Read
Edit
Edit source
View history
More
Search
Navigation
Landing page
Tutorials
Game Systems
Editor Reference
Scripting Reference
Recent changes
Help
Tools
What links here
Related changes
Special pages
Page information
Page values