Torque3D Documentation / _generateds / GuiShapeNameHud

GuiShapeNameHud

consoledoc.h

Displays name and damage of ShapeBase objects in its bounds. Must be a child of a GuiTSCtrl and a server connection must be present.

More...

Colors

LinearColorF

Standard 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 background of each shape name label.

LinearColorF

Color for the frames around each shape name label.

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, we draw a background for each shape name label.

bool

If true, we draw a frame around each shape name label.

Point2I

The padding (in pixels) between the label text and the frame.

float

Amount to vertically offset the control in relation to the ShapeBase object in focus.

float

Visibility distance (how far the player must be from the ShapeBase object in focus) for this control to render.

Detailed Description

Displays name and damage of ShapeBase objects in its bounds. Must be a child of a GuiTSCtrl and a server connection must be present.

This control displays the name and damage value of all named ShapeBase objects on the client. The name and damage of objects within the control's display area are overlayed above the object.

This GUI control must be a child of a TSControl, and a server connection and control object must be present. This is a stand-alone control and relies only on the standard base GuiControl.

 new GuiShapeNameHud(){
   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
   textColor = "1.0 1.0 1.0 1.0"; // Solid white text Color
   showFill = "true";
   showFrame = "true";
   labelFillColor = "0.0 1.0 0.0 1.0"; // Fills with a solid green color
   labelFrameColor = "1.0 1.0 1.0 1.0"; // Solid white frame color
   showLabelFill = "true";
   showLabelFrame = "true";
   verticalOffset = "0.15";
   distanceFade = "15.0";
};

Colors

LinearColorF fillColor 

Standard 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 labelFillColor 

Color for the background of each shape name label.

LinearColorF labelFrameColor 

Color for the frames around each shape name label.

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 showLabelFill 

If true, we draw a background for each shape name label.

bool showLabelFrame 

If true, we draw a frame around each shape name label.

Point2I labelPadding 

The padding (in pixels) between the label text and the frame.

float verticalOffset 

Amount to vertically offset the control in relation to the ShapeBase object in focus.

float distanceFade 

Visibility distance (how far the player must be from the ShapeBase object in focus) for this control to render.