Difference between revisions of "Spell Script"
Jump to navigation
Jump to search
imported>Jog |
imported>CraftySentinel m (Reverted to List) |
||
(11 intermediate revisions by 6 users not shown) | |||
Line 1: | Line 1: | ||
'''Extends:''' [[Form Script]] | '''Extends:''' [[Form Script]] | ||
Line 19: | Line 15: | ||
== Member Functions == | == Member Functions == | ||
''' | :'''[[Cast - Spell|Cast]](ObjectReference ''akSource'', ObjectReference ''akTarget'')''' | ||
*Returns whether this spell is considered hostile or not. | :*Casts this spell from the source object reference, optionally toward a target object reference. | ||
:'''[[IsHostile - Spell|Bool IsHostile]]()''' | |||
:*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 == | |||
:'''Float [[GetCastTime - Spell|GetCastTime]]()''' | |||
:*Returns the time to cast the spell. | |||
:'''Int [[GetNumEffects - Spell|GetNumEffects]]()''' | |||
:*Returns the number of effects on this spell. | |||
:'''Float [[GetNthEffectMagnitude - Spell|GetNthEffectMagnitude]](Int ''index'')''' | |||
:*Returns the magnitude of the specified effect of this spell. | |||
:'''Int [[GetNthEffectArea - Spell|GetNthEffectArea]](Int ''index'')''' | |||
:*Returns the area of the specified effect of this spell. | |||
:'''Int [[GetNthEffectDuration - Spell|GetNthEffectDuration]](Int ''index'')''' | |||
:*Returns the duration of the specified effect of this spell. | |||
:'''MagicEffect [[GetNthEffectMagicEffect - Spell|GetNthEffectMagicEffect]](Int ''index'')''' | |||
:*Returns the MagicEffect of the specified effect of this spell. | |||
:'''Int [[GetCostliestEffectIndex - Spell|GetCostliestEffectIndex]]()''' | |||
:*Returns which effect of the spell has the highest cost. | |||
:'''Int [[GetMagickaCost - Spell|GetMagickaCost]]()''' | |||
:*Returns the base magicka cost of the spell | |||
:'''Int [[GetEffectiveMagickaCost - Spell|GetEffectiveMagickaCost]](Actor ''caster'')''' | |||
:*Returns the effective cost of the spell. | |||
:'''Perk [[GetPerk - Spell|GetPerk]]()''' | |||
:*Returns the perk associated with the spell. | |||
:'''[[SetNthEffectMagnitude - Spell|SetNthEffectMagnitude]](Int ''index'', Float ''value'')''' | |||
:*Sets the magnitude of the specified effect. | |||
:'''[[SetNthEffectArea - Spell|SetNthEffectArea]](Int ''index'', Int ''value'')''' | |||
:*Sets the area of the specified effect. | |||
:'''[[SetNthEffectDuration - Spell|SetNthEffectDuration]](Int ''index'', Int ''value'')''' | |||
:*Sets the duration of the specified effect. | |||
:'''EquipSlot [[GetEquipType - Spell|GetEquipType]]()''' | |||
:*Returns the EquipSlot Type that this spell uses. | |||
:'''[[SetEquipSlotType - Spell|SetEquipSlotType]](EquipSlot ''type'')''' | |||
:*Sets the EquipSlot type to the specified equip slot. | |||
== Events == | == Events == | ||
None | None | ||
[[Category:Scripting]] | |||
[[Category:Papyrus]] | |||
[[Category:Script Objects]] | |||
[[Category:SKSE]] | |||
[[Category:SKSE Script Objects]] |
Latest revision as of 03:41, 3 February 2014
Extends: Form Script
Script for the manipulation of spells.
Definition[edit | edit source]
ScriptName Spell extends Form
Properties[edit | edit source]
None
Global Functions[edit | edit source]
None
Member Functions[edit | edit source]
- 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[edit | edit source]
- 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.
- SetNthEffectMagnitude(Int index, Float value)
- Sets the magnitude of the specified effect.
- SetNthEffectArea(Int index, Int value)
- Sets the area of the specified effect.
- SetNthEffectDuration(Int index, Int value)
- Sets the duration of the specified effect.
- EquipSlot GetEquipType()
- Returns the EquipSlot Type that this spell uses.
- SetEquipSlotType(EquipSlot type)
- Sets the EquipSlot type to the specified equip slot.
Events[edit | edit source]
None