Difference between revisions of "Ingredient Script"

From the CreationKit Wiki
Jump to navigation Jump to search
imported>CraftySentinel
(→‎SKSE Member Functions: Added SetNthEffect Functions)
imported>Egocarib
(updated links)
Line 73: Line 73:
|-
|-


|[[SetNthEffectMagnitude - Ingredient|'''SetNthEffectMagnitude'''(Int ''index'', Float ''value'')]]
|[[SetNthEffectMagnitude - Spell|'''SetNthEffectMagnitude'''(Int ''index'', Float ''value'')]]
|Sets the magnitude of the specified effect.
|Sets the magnitude of the specified effect.
|-
|-


|[[SetNthEffectArea - Ingredient|'''SetNthEffectArea'''(Int ''index'', Int ''value'')]]
|[[SetNthEffectArea - Spell|'''SetNthEffectArea'''(Int ''index'', Int ''value'')]]
|Sets the area of the specified effect.
|Sets the area of the specified effect.
|-
|-


|[[SetNthEffectDuration - Ingredient|'''SetNthEffectDuration'''(Int ''index'', Int ''value'')]]
|[[SetNthEffectDuration - Spell|'''SetNthEffectDuration'''(Int ''index'', Int ''value'')]]
|Sets the duration of the specified effect.
|Sets the duration of the specified effect.
|-
|-

Revision as of 23:58, 20 November 2013


Extends: Form Script

Script that represents an alchemy ingredient.

Definition

ScriptName Ingredient extends Form

Properties

None

Global Functions

None

Member Functions

Function Description
Bool IsHostile() Returns whether this ingredient is considered hostile or not.
LearnEffect(Int aiIndex) Flags the effect with the given index as known by the player.
Int LearnNextEffect() Flags the next unknown effect as known by the player, returning index of learned effect.
LearnAllEffects() Flags the all effects as known by the player.

SKSE Member Functions

Function Description
Int GetNumEffects() Returns the number of effects on this ingredient.
Float GetNthEffectMagnitude(Int index) Returns the magnitude of the specified effect of this ingredient.
Int GetNthEffectArea(Int index) Returns the area of the specified effect of this ingredient.
Int GetNthEffectDuration(Int index) Returns the duration of the specified effect of this ingredient.
MagicEffect GetNthEffectMagicEffect(Int index) Returns the MagicEffect of the specified effect of this ingredient.
Int GetCostliestEffectIndex() Returns which effect of the ingredient has the highest cost.
SetNthEffectMagnitude(Int index, Float value) Sets the magnitude of the specified effect.
SetNthEffectArea(Int index, Int value) Sets the area of the specified effect.
SetNthEffectDuration(Int index, Int value) Sets the duration of the specified effect.

Events

None