AW HUD ELEMENT TEXT

From ActiveWiki
Jump to: navigation, search


Minimum requirements
Added in version 4.1
SDKbuild 64


AW_HUD_ELEMENT_TEXT

Type

String

Description

Text of a HUD element.

Notes

This attribute specifies either the text to be displayed for a HUD element (when AW_HUD_ELEMENT_TYPE is set to AW_HUD_TYPE_TEXT), or the filenames of the texture and mask (when AW_HUD_ELEMENT_TYPE is set to AW_HUD_TYPE_IMAGE).

When NULL, the HUD element displayed is a blank rectangle with no text or image. The element is still clickable, however, so setting this attribute to NULL can be used to create invisible clickable HUD areas.

When non-NULL, and AW_HUD_ELEMENT_TYPE is set to AW_HUD_TYPE_TEXT, the text is displayed within the borders of the HUD element, stretching to fit the element.

When non-NULL, and AW_HUD_ELEMENT_TYPE is set to AW_HUD_TYPE_IMAGE, the image with the filename specified in AW_HUD_ELEMENT_TEXT is displayed in the HUD element. The image may be masked by appending a pipe symbol followed by the name of the mask, such as "tree.jpg|tree.bmp". Images and masks are located in the "\textures" directory of the world's object path.

Used by