Difference between revisions of "Potion Script"
Jump to navigation
Jump to search
imported>PROXiCiDE m (Fixed spacing) |
imported>CraftySentinel m (Formatting Change) |
||
| Line 21: | Line 21: | ||
== Member Functions == | == Member Functions == | ||
{|class="wikitable" width =100% | |||
!style="text-align:left;"|Function | |||
!style="text-align:left;"|Description | |||
|- | |||
|[[IsHostile - Potion|Bool '''IsHostile'''()]] | |||
|Returns whether this potion is considered hostile or not. | |||
|- | |||
|} | |||
== SKSE Member Functions == | == SKSE Member Functions == | ||
''' | {|class="wikitable" width =100% | ||
!style="text-align:left;"|Function | |||
!style="text-align:left;"|Description | |||
|- | |||
|[[IsFood - Potion|Bool '''IsFood'''()]] | |||
|Returns whether the potion is considered food. | |||
|- | |||
|[[GetNumEffects - Potion|Int '''GetNumEffects'''()]] | |||
|Returns the number of effects on this potion. | |||
|- | |||
|[[GetNthEffectMagnitude - Potion|Float '''GetNthEffectMagnitude'''(Int ''index'')]] | |||
|Returns the magnitude of the specified effect of this potion. | |||
|- | |||
|[[GetNthEffectArea - Potion|Int '''GetNthEffectArea'''(Int ''index'')]] | |||
|Returns the area of the specified effect of this potion. | |||
|- | |||
|[[GetNthEffectDuration - Potion|Int '''GetNthEffectDuration'''(Int ''index'')]] | |||
|Returns the duration of the specified effect of this potion. | |||
|- | |||
|[[GetNthEffectMagicEffect - Potion|MagicEffect '''GetNthEffectMagicEffect'''(Int ''index'')]] | |||
|Returns the MagicEffect of the specified effect of this potion. | |||
|- | |||
|[[GetCostliestEffectIndex - Potion|Int '''GetCostliestEffectIndex'''()]] | |||
|Returns which effect of the potion has the highest cost. | |||
|- | |||
|} | |||
== Events == | == Events == | ||
None | None | ||
Revision as of 05:22, 24 October 2013
Extends: Form Script
Script that represents an alchemy potion.
Definition
ScriptName Potion extends FormProperties
None
Global Functions
None
Member Functions
| Function | Description |
|---|---|
| Bool IsHostile() | Returns whether this potion is considered hostile or not. |
SKSE Member Functions
| Function | Description |
|---|---|
| Bool IsFood() | Returns whether the potion is considered food. |
| Int GetNumEffects() | Returns the number of effects on this potion. |
| Float GetNthEffectMagnitude(Int index) | Returns the magnitude of the specified effect of this potion. |
| Int GetNthEffectArea(Int index) | Returns the area of the specified effect of this potion. |
| Int GetNthEffectDuration(Int index) | Returns the duration of the specified effect of this potion. |
| MagicEffect GetNthEffectMagicEffect(Int index) | Returns the MagicEffect of the specified effect of this potion. |
| Int GetCostliestEffectIndex() | Returns which effect of the potion has the highest cost. |
Events
None