Difference between revisions of "Spell Script"

Jump to navigation Jump to search

Spell Script (edit)

Revision as of 03:41, 3 February 2014

802 bytes added ,  03:41, 3 February 2014
m
Reverted to List
imported>Wafflesalot
imported>CraftySentinel
m (Reverted to List)
 
(4 intermediate revisions by 2 users not shown)
Line 1: Line 1:
[[Category:Scripting]]
[[Category:Papyrus]]
[[Category:Script Objects]]
[[Category:SKSE]]
[[Category:SKSE Script Objects]]
'''Extends:''' [[Form Script]]
'''Extends:''' [[Form Script]]


Line 21: Line 15:


== 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]]()'''
:'''[[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
 


'''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


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


'''int Function [[GetNumEffects - Spell|GetNumEffects]]()'''
:'''Float [[GetCastTime - Spell|GetCastTime]]()'''
*Returns the number of effects on this spell.
:*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.


'''float Function [[GetNthEffectMagnitude - Spell|GetNthEffectMagnitude]](int index)'''
:'''Int [[GetNthEffectArea - Spell|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)'''
:'''Int [[GetNthEffectDuration - Spell|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)'''
:'''MagicEffect [[GetNthEffectMagicEffect - Spell|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)'''
:'''Int [[GetCostliestEffectIndex - Spell|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]]()'''
:'''Int [[GetMagickaCost - Spell|GetMagickaCost]]()'''
*Returns which effect of the spell has the highest cost.
:*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.


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


== Events ==
== Events ==
None
None
[[Category:Scripting]]
[[Category:Papyrus]]
[[Category:Script Objects]]
[[Category:SKSE]]
[[Category:SKSE Script Objects]]
Retrieved from "https://ck.uesp.net/wiki/Special:MobileDiff/16057...16062"

Navigation menu