Difference between revisions of "Potion Script"
Jump to navigation
Jump to search
imported>Jog |
imported>Behippo (→Member Functions: Added SKSE Member Function list) |
||
| Line 21: | Line 21: | ||
'''bool Function [[IsHostile - Potion|IsHostile]]()''' | '''bool Function [[IsHostile - Potion|IsHostile]]()''' | ||
*Returns whether this potion is considered hostile or not. | *Returns whether this potion is considered hostile or not. | ||
== SKSE Member Functions == | |||
'''bool Function [[IsFood - Potion|IsFood]]()''' | |||
*Returns whether the potion is considered food. | |||
'''int Function [[GetNumEffects|GetNumEffects]]()''' | |||
*Returns the number of effects on this potion. | |||
'''float Function [[GetNthEffectMagnitude|GetNthEffectMagnitude]](int index)''' | |||
*Returns the magnitude of the specified effect of this potion. | |||
'''int Function [[GetNthEffectArea|GetNthEffectArea]](int index)''' | |||
*Returns the area of the specified effect of this potion. | |||
'''int Function [[GetNthEffectDuration|GetNthEffectDuration]](int index)''' | |||
*Returns the duration of the specified effect of this potion. | |||
'''MagicEffect Function[[GetNthEffectMagicEffect|GetNthEffectMagicEffect]](int index)''' | |||
*Returns the MagicEffect of the specified effect of this potion. | |||
'''int Function [[GetCostliestEffectIndex|GetCostliestEffectIndex]]()''' | |||
*Returns which effect of the potion has the highest cost. | |||
== Events == | == Events == | ||
None | None | ||
Revision as of 02:51, 10 May 2012
Extends: Form Script
Script that represents an alchemy potion.
Definition
ScriptName Potion extends FormProperties
None
Global Functions
None
Member Functions
bool Function IsHostile()
- Returns whether this potion is considered hostile or not.
SKSE Member Functions
bool Function IsFood()
- Returns whether the potion is considered food.
int Function GetNumEffects()
- Returns the number of effects on this potion.
float Function GetNthEffectMagnitude(int index)
- Returns the magnitude of the specified effect of this potion.
int Function GetNthEffectArea(int index)
- Returns the area of the specified effect of this potion.
int Function GetNthEffectDuration(int index)
- Returns the duration of the specified effect of this potion.
MagicEffect FunctionGetNthEffectMagicEffect(int index)
- Returns the MagicEffect of the specified effect of this potion.
int Function GetCostliestEffectIndex()
- Returns which effect of the potion has the highest cost.
Events
None