Torque3D Documentation / _generateds / afxGuiControllerData

afxGuiControllerData

consoledoc.h

A datablock that specifies a Gui Controller effect.

More...

Public Attributes

bool

If true, the effect will only be applied to a gui-control on the client that matches the controlling-client of the primary position constraint object.

string

Specifies the name of an existing gui-control.

bool

When true, the gui-control will retain its initial position, otherwise the gui-control position will be continuously updated using a projection of the 3D constraint position into 2D screen coordinates.

Detailed Description

A datablock that specifies a Gui Controller effect.

A Gui Controller enables effect manipulation of pre-existing gui controls. With a Gui Controller effect, a regular gui control is located by name, made visible during the lifetime of the effect, and potentially repositioned by projecting 3D constraint positions into 2D screen space. In addition, when used with a progress-bar control, (GuiProgressCtrl, afxSpellCastBar, afxStatusBar), the progress-bar will continuously reflect the elapsed progress of the effect over its lifetime.

Public Attributes

bool controllingClientOnly 

If true, the effect will only be applied to a gui-control on the client that matches the controlling-client of the primary position constraint object.

string controlName 

Specifies the name of an existing gui-control.

bool preservePosition 

When true, the gui-control will retain its initial position, otherwise the gui-control position will be continuously updated using a projection of the 3D constraint position into 2D screen coordinates.