Difference between revisions of "ActiveMagicEffect Script"
Jump to navigation
Jump to search
imported>Qazaaq (Added to the Actor category) |
imported>Qazaaq (category, see also edited, description changed) |
||
| (4 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
'''Extends:''' [[ScriptObject Script|ScriptObject]] | '''Extends:''' [[ScriptObject Script|ScriptObject]] | ||
<BR/> | |||
'''Editor:''' [[Magic Effect]] | '''Editor:''' [[Magic Effect]] | ||
Script for the manipulation of active magic effects | Script for the manipulation of active magic effects. An active magic effect is a [[Magic Effect]] which is currently attached to an [[Actor]]. | ||
== Definition == | == Definition == | ||
| Line 36: | Line 32: | ||
== Events == | == Events == | ||
*Event [[OnEffectStart - ActiveMagicEffect|OnEffectStart]](Actor akTarget, Actor akCaster) | *Event [[OnEffectStart - ActiveMagicEffect|OnEffectStart]](Actor akTarget, Actor akCaster) | ||
**Event received when this effect starts | **Event received when this effect starts. | ||
*Event [[OnEffectFinish - ActiveMagicEffect|OnEffectFinish]](Actor akTarget, Actor akCaster) | *Event [[OnEffectFinish - ActiveMagicEffect|OnEffectFinish]](Actor akTarget, Actor akCaster) | ||
**Event received when this effect has finished | **Event received when this effect has finished. | ||
== Notes == | == Notes == | ||
ActiveMagicEffects will also receive events from the [[Actor Script#Events|Actor]] they are attached to. | *ActiveMagicEffects will also receive events from the [[Actor Script#Events|Actor]] they are attached to. | ||
== See Also == | |||
*[[Actor]] | |||
*[[Magic Effect]] | |||
*[[:Category:Actor|Actor Category]] | |||
*[[:Category:Magic|Magic Category]] | |||
[[Category:Scripting]] | |||
[[Category:Papyrus]] | |||
[[Category:Script Objects]] | |||
[[Category:Actor]] | |||
[[Category:Magic]] | |||
Latest revision as of 04:44, 22 October 2017
Extends: ScriptObject
Editor: Magic Effect
Script for the manipulation of active magic effects. An active magic effect is a Magic Effect which is currently attached to an Actor.
Definition[edit | edit source]
ScriptName ActiveMagicEffect extends ScriptObject Native HiddenProperties[edit | edit source]
None
Global Functions[edit | edit source]
None
Member Functions[edit | edit source]
- Function Dispel()
- Dispels this active magic effect.
- MagicEffect Function GetBaseObject()
- Obtains the MagicEffect this active magic effect is based on.
- Actor Function GetCasterActor()
- Obtains the Actor that cast the spell this magic effect is from.
- Actor Function GetTargetActor()
- Obtains the Actor this active magic effect is applied to.
- Function StartObjectProfiling()
- Starts profiling all scripts attached to this magic effect.
- Function StopObjectProfiling()
- Stops profiling all scripts attached to this magic effect.
Events[edit | edit source]
- Event OnEffectStart(Actor akTarget, Actor akCaster)
- Event received when this effect starts.
- Event OnEffectFinish(Actor akTarget, Actor akCaster)
- Event received when this effect has finished.
Notes[edit | edit source]
- ActiveMagicEffects will also receive events from the Actor they are attached to.