Difference between revisions of "Ingredient Script"

From the CreationKit Wiki
Jump to navigation Jump to search
imported>Behippo
(→‎Member Functions: Added SKSE Member Function list)
imported>PurpleLunchbox
Line 32: Line 32:


== SKSE Member Functions ==
== SKSE Member Functions ==
'''int Function [[GetNumEffects|GetNumEffects]]()'''
'''int Function [[GetNumEffects - Ingredient|GetNumEffects]]()'''
*Returns the number of effects on this ingredient.
*Returns the number of effects on this ingredient.


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


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


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


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


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


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

Revision as of 02:59, 10 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 FunctionGetNthEffectMagicEffect(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