[This is preliminary documentation and is subject to change.]
Combinable flags to set different attributes for the HUD.
Represented by the HudElementFlags attribute.
Syntax
| C# |
|---|
[FlagsAttribute] public enum HudElementFlag |
| Visual Basic (Declaration) |
|---|
<FlagsAttribute> _ Public Enumeration HudElementFlag |
Members
| Member name | Description | |
|---|---|---|
| Clicks |
Specifies that the HUD element will raise the EventHudClick event when clicked by the user.
| |
| Stretch |
Specifies that the texture should be resized as needed to force it to fit within the HUD element. By default it will only show as many pixels as it can.
| |
| Additive |
Specifies that the HUD element will perform an additive blend when rendering, thus making it appear to "glow".
| |
| SizePercent |
Currently not available to the SDK.
| |
| Transition |
Specifies that the HUD element will smoothly adjust to its new position, color, texture mapping, and opacity over a period of a half-second when updated.
| |
| Temporary |
Specified along with the transition flag. Then when the HUD element is updated it will move to the new position and then back, with a total round-trip time of one second.
| |
| UniversePath |
Specifies that the HUD element will download its texture from the universe texture path instead of the local world texture path.
| |
| Clamp |
Specifies that the HUD element will lock the edges of its texture, thus preventing it from tiling. If the texture is not big enough to fill the given element space, then the edges are repeated instead of wrapping around to the other side of the texture.
| |
| Highlight |
Specifies that the HUD element will be highlighted. This means that the element slowly pulses between a glowing version and the regular version.
|
