Difference between revisions of "Ingredient Script"

From the CreationKit Wiki
Jump to navigation Jump to search
imported>Rhavlovick
m (1 revision: Clobber re-import by Henning)
 
imported>Jog
Line 19: Line 19:


== Member Functions ==
== Member Functions ==
*bool Function [[IsHostile - Ingredient|IsHostile]]()
'''bool Function [[IsHostile - Ingredient|IsHostile]]()'''
**Returns whether this ingredient is considered hostile or not.
*Returns whether this ingredient is considered hostile or not.
*Function [[LearnEffect - Ingredient|LearnEffect]](int aiIndex)
 
**Flags the effect with the given index as known by the player.
'''Function [[LearnEffect - Ingredient|LearnEffect]](int aiIndex)'''
*int Function [[LearnNextEffect - Ingredient|LearnNextEffect]]()
*Flags the effect with the given index as known by the player.
**Flags the next unknown effect as known by the player, returning index of learned effect.
 
*Function [[LearnAllEffects - Ingredient|LearnAllEffects]]()
'''int Function [[LearnNextEffect - Ingredient|LearnNextEffect]]()'''
**Flags the all effects as known by the player.
*Flags the next unknown effect as known by the player, returning index of learned effect.
 
'''Function [[LearnAllEffects - Ingredient|LearnAllEffects]]()'''
*Flags the all effects as known by the player.


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

Revision as of 12:49, 20 February 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.

Events

None