Torque3D Documentation / _generateds / afxScriptEventData

afxScriptEventData

consoledoc.h

A datablock that specifies a Script Event effect.

More...

Public Attributes

string

The name of a script method defined for the instance class of an effects choreographer. The arguments used to call this method are determined by the type of choreographer.

string

An arbitrary blind data value which is passed in as an argument of the script event method. The value of scriptData can be used to differentiate uses when handling different script event effects with a single method.

Detailed Description

A datablock that specifies a Script Event effect.

Arbitrary script functions can be called as an AFX effect using afxScriptEventData. They are useful for implementing high-level scripted side-effects such as character resurrection or teleportation.

Public Attributes

string methodName 

The name of a script method defined for the instance class of an effects choreographer. The arguments used to call this method are determined by the type of choreographer.

string scriptData 

An arbitrary blind data value which is passed in as an argument of the script event method. The value of scriptData can be used to differentiate uses when handling different script event effects with a single method.