Difference between revisions of "Spell Script"

From the CreationKit Wiki
Jump to navigation Jump to search
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

Revision as of 05:29, 24 October 2013


Extends: Form Script

Script for the manipulation of spells.

Definition

ScriptName Spell extends Form

Properties

None

Global Functions

None

Member Functions

Function Description
Cast(ObjectReference akSource, ObjectReference akTarget) Casts this spell from the source object reference, optionally toward a target object reference.
Bool IsHostile() Returns whether this spell is considered hostile or not.
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

Function Description
Float GetCastTime() Returns the time to cast the spell.
Int GetNumEffects() Returns the number of effects on this spell.
Float GetNthEffectMagnitude(Int index) Returns the magnitude of the specified effect of this spell.
Int GetNthEffectArea(Int index) Returns the area of the specified effect of this spell.
Int GetNthEffectDuration(Int index) Returns the duration of the specified effect of this spell.
MagicEffect GetNthEffectMagicEffect(Int index) Returns the MagicEffect of the specified effect of this spell.
Int GetCostliestEffectIndex() Returns which effect of the spell has the highest cost.
Int GetMagickaCost() Returns the base magicka cost of the spell
Int GetEffectiveMagickaCost(Actor caster) Returns the effective cost of the spell.
Perk GetPerk() Returns the perk associated with the spell.

Events

None

Retrieved from "https://ck.uesp.net/w/index.php?title=Spell_Script&oldid=16060"