Difference between revisions of "Potion Script"
Jump to navigation
Jump to search
imported>Notanon |
imported>Notanon (Added additional SKSE functions as of 1.7.3) |
||
| Line 30: | Line 30: | ||
:'''Bool [[IsFood - Potion|IsFood]]()''' | :'''Bool [[IsFood - Potion|IsFood]]()''' | ||
:*Returns whether the potion is considered food. | :*Returns whether the potion is considered food. | ||
:'''Bool [[IsPoison- Potion|IsPoison]]()''' | |||
:*Returns whether the potion is considered Poison. | |||
:'''Int [[GetNumEffects - Potion|GetNumEffects]]()''' | :'''Int [[GetNumEffects - Potion|GetNumEffects]]()''' | ||
| Line 57: | Line 60: | ||
:'''[[SetNthEffectDuration - Potion|SetNthEffectDuration]](Int ''index'', Int ''value'')''' | :'''[[SetNthEffectDuration - Potion|SetNthEffectDuration]](Int ''index'', Int ''value'')''' | ||
:*Sets the duration of the specified effect. | :*Sets the duration of the specified effect. | ||
:'''SoundDescriptor [[GetUseSound- Potion|GetUseSound]]()''' | :'''SoundDescriptor [[GetUseSound- Potion|GetUseSound]]()''' | ||
:*Returns the [[Sound Descriptor|sound descriptor]] of this potion as a form id. | :*Returns the [[Sound Descriptor|sound descriptor]] of this potion as a form id. | ||
:'''Float [[GetEffectsMagnitude - Potion|GetEffectsMagnitude]]()''' | |||
:*Returns all the magnitudes of this object in order. | |||
:'''Int [[GetEffectAreas- Potion|GetEffectAreas]]()''' | |||
:*Returns all the areas of this object in order. | |||
:'''Int [[GetEffectDurations - Potion|GetEffectDurations]]()''' | |||
:*Returns all the durations of this object in order. | |||
:'''MagicEffect [[GetMagicEffects- Potion|GetMagicEffects]]()''' | |||
:*Returns all the magic effects of this object in order. | |||
== Events == | == Events == | ||
None | None | ||
Revision as of 00:41, 9 June 2015
Extends: Form Script
Script that represents an alchemy potion.
Definition
ScriptName Potion extends FormProperties
None
Global Functions
None
Member Functions
- Bool IsHostile()
- Returns whether this potion is considered hostile or not.
SKSE Member Functions
- Bool IsFood()
- Returns whether the potion is considered food.
- Bool IsPoison()
- Returns whether the potion is considered Poison.
- Int GetNumEffects()
- Returns the number of effects on this potion.
- Float GetNthEffectMagnitude(Int index)
- Returns the magnitude of the specified effect of this potion.
- Int GetNthEffectArea(Int index)
- Returns the area of the specified effect of this potion.
- Int GetNthEffectDuration(Int index)
- Returns the duration of the specified effect of this potion.
- MagicEffect GetNthEffectMagicEffect(Int index)
- Returns the MagicEffect of the specified effect of this potion.
- Int GetCostliestEffectIndex()
- Returns which effect of the potion has the highest cost.
- SetNthEffectMagnitude(Int index, Float value)
- Sets the magnitude of the specified effect.
- SetNthEffectArea(Int index, Int value)
- Sets the area of the specified effect.
- SetNthEffectDuration(Int index, Int value)
- Sets the duration of the specified effect.
- SoundDescriptor GetUseSound()
- Returns the sound descriptor of this potion as a form id.
- Float GetEffectsMagnitude()
- Returns all the magnitudes of this object in order.
- Int GetEffectAreas()
- Returns all the areas of this object in order.
- Int GetEffectDurations()
- Returns all the durations of this object in order.
- MagicEffect GetMagicEffects()
- Returns all the magic effects of this object in order.
Events
None