afxMagicSpell

consoledoc.h

A magic spell effects choreographer.

More...

Public Static Attributes

bool

Disables rendering of all instances of this type.

bool

Disables selection of all instances of this type.

Public Attributes

Public Functions

void

Activates a magic spell that was started with postponeActivation=true.

int

Returns ID of the spell's caster object.

int

Returns ID of impacted-object for the spell.

int

Returns ID of the spell's magic-missile object.

int

Returns ID of the spell's target object.

void

Interrupts and deletes a running magic spell.

void

Interrupts the current stage of a magic spell causing it to move onto the next one.

void
setTimeFactor(F32 factor)

or (string phase, F32 factor)Sets the time-factor for the spell, either overall or for a specific phrase.

Detailed Description

A magic spell effects choreographer.

Public Static Attributes

bool isRenderable 

Disables rendering of all instances of this type.

bool isSelectable 

Disables selection of all instances of this type.

Public Attributes

SimObject caster 

...

SimObject Target 

...

Public Functions

activate()

Activates a magic spell that was started with postponeActivation=true.

getCaster()

Returns ID of the spell's caster object.

getImpactedObject()

Returns ID of impacted-object for the spell.

getMissile()

Returns ID of the spell's magic-missile object.

getTarget()

Returns ID of the spell's target object.

interrupt()

Interrupts and deletes a running magic spell.

interruptStage()

Interrupts the current stage of a magic spell causing it to move onto the next one.

setTimeFactor(F32 factor)

or (string phase, F32 factor)Sets the time-factor for the spell, either overall or for a specific phrase.