Difference between revisions of "Potion Script"

From the CreationKit Wiki
Jump to navigation Jump to search
imported>PurpleLunchbox
imported>PurpleLunchbox
Line 3: Line 3:
[[Category:Script Objects]]
[[Category:Script Objects]]
[[Category:SKSE]]
[[Category:SKSE]]
[[Category:SKSE Script Objects]]


'''Extends:''' [[Form Script]]
'''Extends:''' [[Form Script]]

Revision as of 22:53, 13 May 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