Difference between revisions of "LeveledSpell Script"

From the CreationKit Wiki
Jump to navigation Jump to search
imported>CraftySentinel
m (→‎Member Functions: Formatting Change)
imported>CraftySentinel
(Added SKSE 1.7.0 functions)
 
Line 1: Line 1:
[[Category:Scripting]]
[[Category:Papyrus]]
[[Category:Script Objects]]
'''Extends:''' [[Form Script]]
'''Extends:''' [[Form Script]]


Script for the manipulation of leveled spellbase objects.
Script for the manipulation of leveled spellbase objects.


== Definition ==
== Definition ==
Line 11: Line 8:
ScriptName LeveledSpell extends Form
ScriptName LeveledSpell extends Form
</source>
</source>


== Properties ==
== Properties ==
None
None


== Global Functions ==
== Global Functions ==
None
None


== Member Functions ==
== Member Functions ==


{|class="wikitable" width =100%
:'''[[AddForm - LeveledSpell|AddForm]](Form ''apForm'', Int ''auiLevel'')'''
!style="text-align:left;"|Function
:*Adds the given form to the leveled list under the given level.
!style="text-align:left;"|Description
 
|-
:*[[Revert - LeveledSpell|Revert]]()'''
|[[AddForm - LeveledSpell|'''AddForm'''(Form ''apForm'', Int ''auiLevel'')]]
:*Removes all script added forms from the leveled list.
|Adds the given form to the leveled list under the given level.
 
|-
 
== SKSE Member Functions ==
 
:'''Int [[GetChanceNone - LeveledSpell|GetChanceNone]]()'''
:*Returns the Chance of Getting None for the Leveled List.
 
:'''[[SetChanceNone - LeveledSpell|SetChanceNone]](Int ''chance'')'''
:*Sets the Chance of Getting None for the Leveled List.
 
:'''Int [[GetNumForms - LeveledSpell|GetNumForms]]()'''
:*Returns the number of Forms within the leveled list.
 
:'''Form [[GetNthForm - LeveledSpell|GetNthForm]](Int ''n'')'''
:*Returns the form at the specified index.
 
:'''Int [[GetNthLevel - LeveledSpell|GetNthLevel]](Int ''n'')'''
:*Returns the List Level for the Form at the specified index


|[[Revert - LeveledSpell|'''Revert'''()]]
:'''[[SetNthLevel - LeveledSpell|SetNthLevel]](Int ''n'', Int ''level'')'''
|Removes all script added forms from the leveled list.
:*Sets the list Level for the Form at the specified index to the specified amount.
|-


|}


== Events ==
== Events ==
None
None
[[Category:Scripting]]
[[Category:Papyrus]]
[[Category:Script Objects]]

Latest revision as of 00:07, 3 February 2014

Extends: Form Script

Script for the manipulation of leveled spellbase objects.


Definition[edit | edit source]

ScriptName LeveledSpell extends Form


Properties[edit | edit source]

None


Global Functions[edit | edit source]

None


Member Functions[edit | edit source]

AddForm(Form apForm, Int auiLevel)
  • Adds the given form to the leveled list under the given level.
  • Revert()
  • Removes all script added forms from the leveled list.


SKSE Member Functions[edit | edit source]

Int GetChanceNone()
  • Returns the Chance of Getting None for the Leveled List.
SetChanceNone(Int chance)
  • Sets the Chance of Getting None for the Leveled List.
Int GetNumForms()
  • Returns the number of Forms within the leveled list.
Form GetNthForm(Int n)
  • Returns the form at the specified index.
Int GetNthLevel(Int n)
  • Returns the List Level for the Form at the specified index
SetNthLevel(Int n, Int level)
  • Sets the list Level for the Form at the specified index to the specified amount.


Events[edit | edit source]

None