Difference between revisions of "Potion Script"

Jump to navigation Jump to search
202 bytes added ,  05:22, 24 October 2013
m
Formatting Change
imported>PROXiCiDE
m (Fixed spacing)
imported>CraftySentinel
m (Formatting Change)
Line 21: Line 21:


== Member Functions ==
== Member Functions ==
'''bool Function [[IsHostile - Potion|IsHostile]]()'''
 
*Returns whether this potion is considered hostile or not.
{|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 ==
'''bool Function [[IsFood - Potion|IsFood]]()'''
*Returns whether the potion is considered food.


'''int Function [[GetNumEffects - Potion|GetNumEffects]]()'''
{|class="wikitable" width =100%
*Returns the number of effects on this potion.
!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.
|-


'''float Function [[GetNthEffectMagnitude - Potion|GetNthEffectMagnitude]](int index)'''
|[[GetNthEffectArea - Potion|Int '''GetNthEffectArea'''(Int ''index'')]]
*Returns the magnitude of the specified effect of this potion.
|Returns the area of the specified effect of this potion.
|-


'''int Function [[GetNthEffectArea - Potion|GetNthEffectArea]](int index)'''
|[[GetNthEffectDuration - Potion|Int '''GetNthEffectDuration'''(Int ''index'')]]
*Returns the area of the specified effect of this potion.
|Returns the duration of the specified effect of this potion.
|-


'''int Function [[GetNthEffectDuration - Potion|GetNthEffectDuration]](int index)'''
|[[GetNthEffectMagicEffect - Potion|MagicEffect '''GetNthEffectMagicEffect'''(Int ''index'')]]
*Returns the duration of the specified effect of this potion.
|Returns the MagicEffect of the specified effect of this potion.
|-


'''MagicEffect Function [[GetNthEffectMagicEffect - Potion|GetNthEffectMagicEffect]](int index)'''
|[[GetCostliestEffectIndex - Potion|Int '''GetCostliestEffectIndex'''()]]
*Returns the MagicEffect of the specified effect of this potion.
|Returns which effect of the potion has the highest cost.
|-


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


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

Navigation menu