Difference between revisions of "LeveledItem Script"
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: | ||
'''Extends:''' [[Form Script]] | '''Extends:''' [[Form Script]] | ||
Script for the manipulation of leveled item base objects. | Script for the manipulation of leveled item base objects. | ||
== Definition == | == Definition == | ||
| Line 11: | Line 8: | ||
ScriptName LeveledItem extends Form | ScriptName LeveledItem extends Form | ||
</source> | </source> | ||
== Properties == | == Properties == | ||
None | None | ||
== Global Functions == | == Global Functions == | ||
None | None | ||
== Member Functions == | == Member Functions == | ||
:'''[[AddForm - LeveledItem|AddForm]](Form ''apForm'', Int ''auiLevel'', Int ''auiCount'')''' | |||
:*Adds the given count of given form to the leveled list under the given level. | |||
:'''[[Revert - LeveledItem|Revert]]()''' | |||
:*Removes all script added forms from the leveled list. | |||
| | |||
== SKSE Member Functions == | |||
|[[ | :'''Int [[GetChanceNone - LeveledItem|GetChanceNone]]()''' | ||
| | :*Returns the Chance of Getting None for the Leveled List. | ||
|- | |||
:'''[[SetChanceNone - LeveledItem|SetChanceNone]](Int ''chance'')''' | |||
:*Sets the Chance of Getting None for the Leveled List. | |||
:'''GlobalVariable [[GetChanceGlobal - LeveledItem|GetChanceGlobal]]()''' | |||
:*Returns the GlobalVariable(If used) used for calculating Chance None for the leveled list. | |||
:'''[[SetChanceGlobal - LeveledItem|SetChanceGlobal]](GlobalVariable ''glob'')''' | |||
:*Sets the GlobalVariable used for calculating Chance None for the leveled list. | |||
:'''Int [[GetNumForms - LeveledItem|GetNumForms]]()''' | |||
:*Returns the number of Forms within the leveled list. | |||
:'''Form [[GetNthForm - LeveledItem|GetNthForm]](Int ''n'')''' | |||
:*Returns the form at the specified index. | |||
:'''Int [[GetNthLevel - LeveledItem|GetNthLevel]](Int ''n'')''' | |||
:*Returns the List Level for the Form at the specified index | |||
:'''[[SetNthLevel - LeveledItem|SetNthLevel]](Int ''n'', Int ''level'')''' | |||
:*Sets the list Level for the Form at the specified index to the specified amount. | |||
:'''Int [[GetNthCount - LeveledItem|GetNthCount]](Int ''n'')''' | |||
:*Returns the count for the Form at the specified index. | |||
:'''Int [[SetNthCount - LeveledItem|SetNthCount]](Int ''n'', Int ''count'')''' | |||
:*Sets the count for the Form at the specified index | |||
== Events == | == Events == | ||
None | None | ||
[[Category:Scripting]] | |||
[[Category:Papyrus]] | |||
[[Category:Script Objects]] | |||
Revision as of 00:01, 3 February 2014
Extends: Form Script
Script for the manipulation of leveled item base objects.
Definition
ScriptName LeveledItem extends Form
Properties
None
Global Functions
None
Member Functions
- AddForm(Form apForm, Int auiLevel, Int auiCount)
- Adds the given count of given form to the leveled list under the given level.
- Revert()
- Removes all script added forms from the leveled list.
SKSE Member Functions
- 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.
- GlobalVariable GetChanceGlobal()
- Returns the GlobalVariable(If used) used for calculating Chance None for the leveled list.
- SetChanceGlobal(GlobalVariable glob)
- Sets the GlobalVariable used for calculating Chance 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.
- Int GetNthCount(Int n)
- Returns the count for the Form at the specified index.
- Int SetNthCount(Int n, Int count)
- Sets the count for the Form at the specified index
Events
None