Torque3D Documentation / _generateds / GuiHealthBarHud

GuiHealthBarHud

consoledoc.h

A basic health bar. Shows the damage value of the current PlayerObjectType control object.

More...

Colors

LinearColorF

Standard color for the background of the control.

LinearColorF

Color for the control's frame.

LinearColorF

As the health bar depletes, this color will represent the health loss amount.

Pulse

int

Speed at which the control will pulse.

float

Health level the control must be under before the control will pulse.

Misc

bool

If true, we draw the background color of the control.

bool

If true, we draw the frame of the control.

bool

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

bool

If true, will fill bar in opposite direction.

Detailed Description

A basic health bar. Shows the damage value of the current PlayerObjectType control object.

This gui displays the damage value of the current PlayerObjectType control object. The gui can be set to pulse if the health value 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 GuiHealthBarHud(){
   fillColor = "0.0 1.0 0.0 1.0"; // Fills with a solid green color
   frameColor = "1.0 1.0 1.0 1.0"; // Solid white frame color
   damageFillColor = "1.0 0.0 0.0 1.0"; // Fills with a solid red color
   pulseRate = "500";
   pulseThreshold = "0.25";
   showFill = "true";
   showFrame = "true";
   displayEnergy = "false";
};

Colors

LinearColorF fillColor 

Standard color for the background of the control.

LinearColorF frameColor 

Color for the control's frame.

LinearColorF damageFillColor 

As the health bar depletes, this color will represent the health loss amount.

Pulse

int pulseRate 

Speed at which the control will pulse.

float pulseThreshold 

Health level the control must be under before the control will pulse.

Misc

bool showFill 

If true, we draw the background color of the control.

bool showFrame 

If true, we draw the frame of the control.

bool displayEnergy 

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

bool flip 

If true, will fill bar in opposite direction.