Difference between revisions of "Spell Script"

From the CreationKit Wiki
Jump to navigation Jump to search
imported>Jog
imported>Behippo
(→‎SKSE Member Functions: Added SKSE Member Function list)
Line 27: Line 27:
'''Function [[RemoteCast - Spell|RemoteCast]](ObjectReference akSource, Actor akBlameActor, ObjectReference akTarget)'''
'''Function [[RemoteCast - Spell|RemoteCast]](ObjectReference akSource, Actor akBlameActor, ObjectReference akTarget)'''
*Casts this spell from the source object reference, with akBlameActor getting blame for any crime
*Casts this spell from the source object reference, with akBlameActor getting blame for any crime
== SKSE Member Functions ==
'''float Function [[GetCastTime - Spell|GetCastTime]]()'''
*Returns the time to cast the spell.
'''int Function [[GetNumEffects|GetNumEffects]]()'''
*Returns the number of effects on this spell.
'''float Function [[GetNthEffectMagnitude|GetNthEffectMagnitude]](int index)'''
*Returns the magnitude of the specified effect of this spell.
'''int Function [[GetNthEffectArea|GetNthEffectArea]](int index)'''
*Returns the area of the specified effect of this spell.
'''int Function [[GetNthEffectDuration|GetNthEffectDuration]](int index)'''
*Returns the duration of the specified effect of this spell.
'''MagicEffect Function[[GetNthEffectMagicEffect|GetNthEffectMagicEffect]](int index)'''
*Returns the MagicEffect of the specified effect of this spell.
'''int Function [[GetCostliestEffectIndex|GetCostliestEffectIndex]]()'''
*Returns which effect of the spell has the highest cost.


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

Revision as of 02:55, 10 May 2012


Extends: Form Script

Script for the manipulation of spells.

Definition

ScriptName Spell extends Form

Properties

None

Global Functions

None

Member Functions

Function Cast(ObjectReference akSource, ObjectReference akTarget)

  • Casts this spell from the source object reference, optionally toward a target object reference.

bool Function IsHostile()

  • Returns whether this spell is considered hostile or not.

Function 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

float Function GetCastTime()

  • Returns the time to cast the spell.

int Function GetNumEffects()

  • Returns the number of effects on this spell.

float Function GetNthEffectMagnitude(int index)

  • Returns the magnitude of the specified effect of this spell.

int Function GetNthEffectArea(int index)

  • Returns the area of the specified effect of this spell.

int Function GetNthEffectDuration(int index)

  • Returns the duration of the specified effect of this spell.

MagicEffect FunctionGetNthEffectMagicEffect(int index)

  • Returns the MagicEffect of the specified effect of this spell.

int Function GetCostliestEffectIndex()

  • Returns which effect of the spell has the highest cost.

Events

None