Torque3D Documentation / _generateds / GuiHealthTextHud

GuiHealthTextHud

consoledoc.h

Shows the health or energy value of the current PlayerObjectType control object.

More...

Colors

LinearColorF

Color for the background of the control.

LinearColorF

Color for the control's frame.

LinearColorF

Color for the text on this control.

LinearColorF

Color for the text when health is low.

View

bool

If true, draw the background.

bool

If true, draw the frame.

bool

If true, we don't hardcode maxHealth to 100.

bool

If true, display the energy value rather than the damage value.

Alert

float

The health level at which to use the warningColor.

float

Health level at which to begin pulsing.

int

Speed at which the control will pulse.

Detailed Description

Shows the health or energy value of the current PlayerObjectType control object.

This gui can be configured to display either the health or energy value of the current Player Object. It can use an alternate display color if the health or drops below a set value. It can also be set to pulse if the health or energy drops below a set value. This control only works if a server connection exists and it's control object is a PlayerObjectType. If either of these requirements is false, the control is not rendered.

 new GuiHealthTextHud(){
   fillColor = "0.0 0.0 0.0 0.5"; // Fills with a transparent black color
   frameColor = "1.0 1.0 1.0 1.0"; // Solid white frame color
   textColor = "0.0 1.0 0.0 1.0" // Solid green text color
   warningColor = "1.0 0.0 0.0 1.0"; // Solid red color, used when damaged
   showFill = "true";
   showFrame = "true";
   showTrueValue = "false";
   showEnergy = "false";
   warnThreshold = "50";
   pulseThreshold = "25";
   pulseRate = "500";
   profile = "GuiBigTextProfile";
};

Colors

LinearColorF fillColor 

Color for the background of the control.

LinearColorF frameColor 

Color for the control's frame.

LinearColorF textColor 

Color for the text on this control.

LinearColorF warningColor 

Color for the text when health is low.

View

bool showFill 

If true, draw the background.

bool showFrame 

If true, draw the frame.

bool showTrueValue 

If true, we don't hardcode maxHealth to 100.

bool showEnergy 

If true, display the energy value rather than the damage value.

Alert

float warnThreshold 

The health level at which to use the warningColor.

float pulseThreshold 

Health level at which to begin pulsing.

int pulseRate 

Speed at which the control will pulse.