Potion Script
Revision as of 16:40, 7 May 2015 by imported>Kerberus14 (→SKSE Member Functions)
Extends: Form Script
Script that represents an alchemy potion.
Definition
ScriptName Potion extends Form
Properties
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.
- 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.
- Bool IsPoison()
- Returns whether the potion is considered Poison.
- SoundDescriptor GetUseSound()
- Returns the sound descriptor of this potion as a form id.
Events
None