Difference between revisions of "Potion Script"

From the CreationKit Wiki
Jump to navigation Jump to search
imported>Cipscis
(Updated links to point to function pages with appropriate names)
imported>PROXiCiDE
m (Fixed spacing)
Line 40: Line 40:
*Returns the duration of the specified effect of this potion.
*Returns the duration of the specified effect of this potion.


'''MagicEffect Function[[GetNthEffectMagicEffect - Potion|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.



Revision as of 19:47, 2 May 2013


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 Function GetNthEffectMagicEffect(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