ActiveMagicEffect Script
Revision as of 14:57, 30 November 2015 by imported>Plplecuyer (→Definition)
Extends: ScriptObject
Script for the manipulation of active magic effects (MagicEffects currently attached to an Actor)
Definition
ScriptName ActiveMagicEffect extends ScriptObject Native Hidden
Properties
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
ActiveMagicEffects will also receive events from the Actor they are attached to.