Difference between revisions of "Spell Script"

From the CreationKit Wiki
Jump to navigation Jump to search
imported>Wafflesalot
imported>Dominoid
(Added missing functions)
Line 51: Line 51:
'''int Function [[GetCostliestEffectIndex - Spell|GetCostliestEffectIndex]]()'''
'''int Function [[GetCostliestEffectIndex - Spell|GetCostliestEffectIndex]]()'''
*Returns which effect of the spell has the highest cost.
*Returns which effect of the spell has the highest cost.
'''int Function [[GetMagickaCost - Spell|GetMagickaCost]]()'''
*Returns the base magicka cost of the spell


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


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

Revision as of 09:18, 15 March 2013


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.

int Function GetMagickaCost()

  • Returns the base magicka cost of the spell

int Function GetEffectiveMagickaCost(Actor caster)

  • Returns the effective cost of the spell.

Perk Function GetPerk()

  • Return the perk associated with the spell.

Events

None