Difference between revisions of "ActiveMagicEffect Script"
Jump to navigation
Jump to search
imported>Qazaaq (Crosslinked to editor reference) |
imported>Qazaaq m |
||
| Line 39: | Line 39: | ||
**Event received when this effect has finished | **Event received when this effect has finished | ||
== 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. | ||
Revision as of 21:41, 6 June 2016
Extends: ScriptObject
Editor: Magic Effect
Script for the manipulation of active magic effects (MagicEffects currently attached to an Actor)
Definition
ScriptName ActiveMagicEffect extends ScriptObject Native HiddenProperties
None
Global Functions
None
Member Functions
- 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
- 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
ActiveMagicEffects will also receive events from the Actor they are attached to.