ActiveMagicEffect Script
Revision as of 05:44, 22 October 2017 by imported>Qazaaq (category, see also edited, description changed)
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.
DefinitionEdit
ScriptName ActiveMagicEffect extends ScriptObject Native HiddenPropertiesEdit
None
Global FunctionsEdit
None
Member FunctionsEdit
- 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.
EventsEdit
- 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.
NotesEdit
- ActiveMagicEffects will also receive events from the Actor they are attached to.