Difference between revisions of "Ingredient Script"

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


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

Revision as of 22:03, 13 May 2012


Extends: Form Script

Script that represents an alchemy ingredient.

Definition

ScriptName Ingredient extends Form

Properties

None

Global Functions

None

Member Functions

bool Function IsHostile()

  • Returns whether this ingredient is considered hostile or not.

Function LearnEffect(int aiIndex)

  • Flags the effect with the given index as known by the player.

int Function LearnNextEffect()

  • Flags the next unknown effect as known by the player, returning index of learned effect.

Function LearnAllEffects()

  • Flags the all effects as known by the player.

SKSE Member Functions

int Function GetNumEffects()

  • Returns the number of effects on this ingredient.

float Function GetNthEffectMagnitude(int index)

  • Returns the magnitude of the specified effect of this ingredient.

int Function GetNthEffectArea(int index)

  • Returns the area of the specified effect of this ingredient.

int Function GetNthEffectDuration(int index)

  • Returns the duration of the specified effect of this ingredient.

MagicEffect Function GetNthEffectMagicEffect(int index)

  • Returns the MagicEffect of the specified effect of this ingredient.

int Function GetCostliestEffectIndex()

  • Returns which effect of the ingredient has the highest cost.

Events

None