Torque 3D - Script Manual: GuiShapeNameHud Class Reference

TorqueScript

Main   Class List   Namespace List   Online

GuiShapeNameHud Class Reference
[Game Controls]

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...

Inheritance diagram for GuiShapeNameHud:

List of all members.

Public Attributes

Misc

float distanceFade
 Visibility distance (how far the player must be from the ShapeBase object in focus) for this control to render.
bool showFill
 If true, we draw the background color of the control.
bool showFrame
 If true, we draw the frame of the control.
float verticalOffset
 Amount to vertically offset the control in relation to the ShapeBase object in focus.
Colors

ColorF fillColor
 Standard color for the background of the control.
ColorF frameColor
 Color for the control's frame.
ColorF textColor
 Color for the text on this control.

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.

Example:
 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";
   verticalOffset = "0.15";
   distanceFade = "15.0";
};

Member Data Documentation

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

Standard color for the background of the control.

Color for the control's frame.

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

If true, we draw the frame of the control.

Color for the text on this control.

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



Copyright © GarageGames, LLC. All Rights Reserved.