Difference between revisions of "Spell Script"

Jump to navigation Jump to search

Spell Script (edit)

Revision as of 05:29, 24 October 2013

202 bytes added ,  05:29, 24 October 2013
m
Formatting Change
imported>Dominoid
imported>CraftySentinel
m (Formatting Change)
Line 21: Line 21:


== Member Functions ==
== Member Functions ==
'''Function [[Cast - Spell|Cast]](ObjectReference akSource, ObjectReference akTarget)'''
*Casts this spell from the source object reference, optionally toward a target object reference.


'''bool Function [[IsHostile - Spell|IsHostile]]()'''
{|class="wikitable" width =100%
*Returns whether this spell is considered hostile or not.
!style="text-align:left;"|Function
!style="text-align:left;"|Description
|-
|[[Cast - Spell|'''Cast'''(ObjectReference ''akSource'', ObjectReference ''akTarget'')]]
|Casts this spell from the source object reference, optionally toward a target object reference.
|-


'''Function [[RemoteCast - Spell|RemoteCast]](ObjectReference akSource, Actor akBlameActor, ObjectReference akTarget)'''
|[[IsHostile - Spell|Bool '''IsHostile'''()]]
*Casts this spell from the source object reference, with akBlameActor getting blame for any crime
|Returns whether this spell is considered hostile or not.
|-
 
|[[RemoteCast - Spell|'''RemoteCast'''(ObjectReference ''akSource'', Actor ''akBlameActor'', ObjectReference ''akTarget'')]]
|Casts this spell from the source object reference, with akBlameActor getting blame for any crime
|-
 
|}


== SKSE Member Functions ==
== SKSE Member Functions ==
'''float Function [[GetCastTime - Spell|GetCastTime]]()'''
*Returns the time to cast the spell.


'''int Function [[GetNumEffects - Spell|GetNumEffects]]()'''
{|class="wikitable" width =100%
*Returns the number of effects on this spell.
!style="text-align:left;"|Function
!style="text-align:left;"|Description
|-
|[[GetCastTime - Spell|Float '''GetCastTime'''()]]
|Returns the time to cast the spell.
|-
 
|[[GetNumEffects - Spell|Int '''GetNumEffects'''()]]
|Returns the number of effects on this spell.
|-
 
|[[GetNthEffectMagnitude - Spell|Float '''GetNthEffectMagnitude'''(Int ''index'')]]
|Returns the magnitude of the specified effect of this spell.
|-


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


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


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


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


'''int Function [[GetCostliestEffectIndex - Spell|GetCostliestEffectIndex]]()'''
|[[GetMagickaCost - Spell|Int '''GetMagickaCost'''()]]
*Returns which effect of the spell has the highest cost.
|Returns the base magicka cost of the spell
|-


'''int Function [[GetMagickaCost - Spell|GetMagickaCost]]()'''
|[[GetEffectiveMagickaCost - Spell|Int '''GetEffectiveMagickaCost'''(Actor ''caster'')]]
*Returns the base magicka cost of the spell
|Returns the effective cost of the spell.
|-


'''int Function [[GetEffectiveMagickaCost - Spell|GetEffectiveMagickaCost]](Actor caster)'''
|[[GetPerk - Spell|Perk '''GetPerk'''()]]
*Returns the effective cost of the spell.
|Returns the perk associated with the spell.
|-


'''Perk Function [[GetPerk - Spell|GetPerk]]()'''
|}
*Returns the perk associated with the spell.


== Events ==
== Events ==
None
None
Retrieved from "https://ck.uesp.net/wiki/Special:MobileDiff/16060"

Navigation menu