Difference between revisions of "Potion Script"

From the CreationKit Wiki
Jump to navigation Jump to search
imported>PurpleLunchbox
imported>Cipscis
(Updated links to point to function pages with appropriate names)
Line 28: Line 28:
*Returns whether the potion is considered food.
*Returns whether the potion is considered food.


'''int Function [[GetNumEffects|GetNumEffects]]()'''
'''int Function [[GetNumEffects - Potion|GetNumEffects]]()'''
*Returns the number of effects on this potion.
*Returns the number of effects on this potion.


'''float Function [[GetNthEffectMagnitude|GetNthEffectMagnitude]](int index)'''
'''float Function [[GetNthEffectMagnitude - Potion|GetNthEffectMagnitude]](int index)'''
*Returns the magnitude of the specified effect of this potion.
*Returns the magnitude of the specified effect of this potion.


'''int Function [[GetNthEffectArea|GetNthEffectArea]](int index)'''
'''int Function [[GetNthEffectArea - Potion|GetNthEffectArea]](int index)'''
*Returns the area of the specified effect of this potion.
*Returns the area of the specified effect of this potion.


'''int Function [[GetNthEffectDuration|GetNthEffectDuration]](int index)'''
'''int Function [[GetNthEffectDuration - Potion|GetNthEffectDuration]](int index)'''
*Returns the duration of the specified effect of this potion.
*Returns the duration of the specified effect of this potion.


'''MagicEffect Function[[GetNthEffectMagicEffect|GetNthEffectMagicEffect]](int index)'''
'''MagicEffect Function[[GetNthEffectMagicEffect - Potion|GetNthEffectMagicEffect]](int index)'''
*Returns the MagicEffect of the specified effect of this potion.
*Returns the MagicEffect of the specified effect of this potion.


'''int Function [[GetCostliestEffectIndex|GetCostliestEffectIndex]]()'''
'''int Function [[GetCostliestEffectIndex - Potion|GetCostliestEffectIndex]]()'''
*Returns which effect of the potion has the highest cost.
*Returns which effect of the potion has the highest cost.


== Events ==
== Events ==
None
None

Revision as of 15:53, 5 September 2012


Extends: Form Script

Script that represents an alchemy potion.

Definition

ScriptName Potion extends Form

Properties

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