Difference between revisions of "GetNthEffectArea - Enchantment"

From the CreationKit Wiki
Jump to navigation Jump to search
imported>PurpleLunchbox
 
imported>Cipscis
m (Cipscis moved page GetNthEffectArea to GetNthEffectArea - Enchantment: Standardising name)
 
(2 intermediate revisions by 2 users not shown)
Line 2: Line 2:
[[Category:Papyrus]]
[[Category:Papyrus]]
[[Category:SKSE]]
[[Category:SKSE]]
'''SKSE Member of:''' [[Enchantment Script]], [[Ingredient Script]], [[Potion Script]], and [[Spell Script]]  
'''SKSE Member of:''' [[Enchantment Script]], [[Ingredient Script]], [[Potion Script]], [[Scroll Script]], and [[Spell Script]]  


Returns the area of the Nth effect attached to this enchantment, ingredient, potion, or spell. (This function requires SKSE)
Returns the area of the Nth effect attached to this enchantment, ingredient, potion, or spell. (This function requires SKSE)
Line 8: Line 8:
== Syntax ==
== Syntax ==
<source lang="papyrus">
<source lang="papyrus">
float Function GetNthEffectArea(int n) native
int Function GetNthEffectArea(int n) native
</source>
</source>


Line 19: Line 19:
== Examples ==
== Examples ==
<source lang="papyrus">
<source lang="papyrus">
float area = enchantment.GetNthEffectArea(0)
int area = enchantment.GetNthEffectArea(0)
Debug.Trace("Enchantments first effect has an area of " + area)
Debug.Trace("Enchantments first effect has an area of " + area)
</source>
</source>
Line 27: Line 27:
*[[Ingredient Script]]
*[[Ingredient Script]]
*[[Potion Script]]
*[[Potion Script]]
*[[Scroll Script]]
*[[Spell Script]]
*[[Spell Script]]

Latest revision as of 15:44, 5 September 2012

SKSE Member of: Enchantment Script, Ingredient Script, Potion Script, Scroll Script, and Spell Script

Returns the area of the Nth effect attached to this enchantment, ingredient, potion, or spell. (This function requires SKSE)

Syntax[edit | edit source]

int Function GetNthEffectArea(int n) native

Parameters[edit | edit source]

  • n: The index of which effect area will be returned.

Return Value[edit | edit source]

Returns the area of the Nth effect attached to this enchantment, ingredient, potion, or spell.

Examples[edit | edit source]

int area = enchantment.GetNthEffectArea(0)
Debug.Trace("Enchantments first effect has an area of " + area)

See Also[edit | edit source]