Difference between revisions of "Potion Script"
Jump to navigation
Jump to search
imported>Rhavlovick m (1 revision: Clobber re-import by Henning) |
imported>Palingard |
||
| (22 intermediate revisions by 11 users not shown) | |||
| Line 2: | Line 2: | ||
[[Category:Papyrus]] | [[Category:Papyrus]] | ||
[[Category:Script Objects]] | [[Category:Script Objects]] | ||
[[Category:SKSE]] | |||
[[Category:SKSE Script Objects]] | |||
'''Extends:''' [[Form Script]] | '''Extends:''' [[Form Script]] | ||
| Line 19: | Line 21: | ||
== Member Functions == | == Member Functions == | ||
:'''Bool [[IsHostile - Potion|IsHostile]]()''' | |||
:*Returns whether this potion is considered hostile or not. | |||
== SKSE Member Functions == | |||
:'''Bool [[IsFood - Potion|IsFood]]()''' | |||
:*Returns whether the potion is considered food. | |||
:'''Bool [[IsPoison- Potion|IsPoison]]()''' | |||
:*Returns whether the potion is considered Poison. | |||
:'''Int [[GetNumEffects - Potion|GetNumEffects]]()''' | |||
:*Returns the number of effects on this potion. | |||
:'''Float [[GetNthEffectMagnitude - Potion|GetNthEffectMagnitude]](Int ''index'')''' | |||
:*Returns the magnitude of the specified effect of this potion. | |||
:'''Int [[GetNthEffectArea - Potion|GetNthEffectArea]](Int ''index'')''' | |||
:*Returns the area of the specified effect of this potion. | |||
:'''Int [[GetNthEffectDuration - Potion|GetNthEffectDuration]](Int ''index'')''' | |||
:*Returns the duration of the specified effect of this potion. | |||
:'''MagicEffect [[GetNthEffectMagicEffect - Potion|GetNthEffectMagicEffect]](Int ''index'')''' | |||
:*Returns the MagicEffect of the specified effect of this potion. | |||
:'''Int [[GetCostliestEffectIndex - Potion|GetCostliestEffectIndex]]()''' | |||
:*Returns which effect of the potion has the highest cost. | |||
:'''[[SetNthEffectMagnitude - Potion|SetNthEffectMagnitude]](Int ''index'', Float ''value'')''' | |||
:*Sets the magnitude of the specified effect. | |||
:'''[[SetNthEffectArea - Potion|SetNthEffectArea]](Int ''index'', Int ''value'')''' | |||
:*Sets the area of the specified effect. | |||
:'''[[SetNthEffectDuration - Potion|SetNthEffectDuration]](Int ''index'', Int ''value'')''' | |||
:*Sets the duration of the specified effect. | |||
:'''SoundDescriptor [[GetUseSound- Potion|GetUseSound]]()''' | |||
:*Returns the [[Sound Descriptor|sound descriptor]] of this potion as a form id. | |||
:'''Float[] [[GetEffectMagnitudes - Potion|GetEffectMagnitudes]]()''' | |||
:*Returns all the magnitudes of this object in order. | |||
:'''Int[] [[GetEffectAreas- Potion|GetEffectAreas]]()''' | |||
:*Returns all the areas of this object in order. | |||
:'''Int[] [[GetEffectDurations - Potion|GetEffectDurations]]()''' | |||
:*Returns all the durations of this object in order. | |||
:'''MagicEffect[] [[GetMagicEffects- Potion|GetMagicEffects]]()''' | |||
:*Returns all the magic effects of this object in order. | |||
== Events == | == Events == | ||
None | None | ||
Latest revision as of 08:37, 23 September 2016
Extends: Form Script
Script that represents an alchemy potion.
Definition[edit | edit source]
ScriptName Potion extends FormProperties[edit | edit source]
None
Global Functions[edit | edit source]
None
Member Functions[edit | edit source]
- Bool IsHostile()
- Returns whether this potion is considered hostile or not.
SKSE Member Functions[edit | edit source]
- Bool IsFood()
- Returns whether the potion is considered food.
- Bool IsPoison()
- Returns whether the potion is considered Poison.
- 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.
- 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.
- SoundDescriptor GetUseSound()
- Returns the sound descriptor of this potion as a form id.
- Float[] GetEffectMagnitudes()
- Returns all the magnitudes of this object in order.
- Int[] GetEffectAreas()
- Returns all the areas of this object in order.
- Int[] GetEffectDurations()
- Returns all the durations of this object in order.
- MagicEffect[] GetMagicEffects()
- Returns all the magic effects of this object in order.
Events[edit | edit source]
None