UE3:UTHUD (UT3)

Object >> Actor >> HUD >> GameHUD >> UTHUD

Package: 

UTGame

Direct subclasses:

UTTeamHUD, UTBetrayalHUD

This class in other games:

UDK

UTHUD UT Heads Up Display

Copyright 1998-2007 Epic Games, Inc. All Rights Reserved.

Properties

See UTHUD properties.

Structs

DamageInfo

Modifiers: native

Holds the various data for each Damage Type

float FadeTime 

float FadeValue 

MaterialInstanceConstant MatConstant 

Functions

Static native functions

TranslateBindToFont

native static function TranslateBindToFont (string InBindStr, out Font DrawFont, out string OutBindStr)

Convert a string with potential escape sequenced data in it to a font and the string that should be displayed

Other static functions

DrawBackground

static simulated function DrawBackground (float X, float Y, float Width, float Height, Object.LinearColor DrawColor, Canvas DrawCanvas)

DrawBarGraph

static simulated function DrawBarGraph (float X, float Y, float Width, float MaxWidth, float Height, Canvas DrawCanvas, Object.Color BarColor, Object.Color BackColor)

DrawHealth

static simulated function DrawHealth (float X, float Y, float Width, float MaxWidth, float Height, Canvas DrawCanvas, optional byte Alpha)

Draw a beacon healthbar

Parameters:

• Width - is the actual health width
• MaxWidth - corresponds to the max health

FormatTime

static function string FormatTime (int Seconds)

Creates a string from the time

GetFontSizeIndex

static function Font GetFontSizeIndex (int FontSize)

Overrides: HUD.GetFontSizeIndex

GetTeamColor

static simulated function GetTeamColor (int TeamIndex, optional out Object.LinearColor ImageColor, optional out Object.Color TextColor)

Exec functions

GrowHUD

exec function GrowHUD ()

Add missing elements to HUD

ReleaseShowScores

exec function ReleaseShowScores ()

SetShowScores

exec function SetShowScores (bool bNewValue)

Overrides: HUD.SetShowScores

sets bShowScores to a specific value (not toggle)

ShowAllAI

exec function ShowAllAI ()

ShowQuickPickMenu

exec function ShowQuickPickMenu (bool bShow)

Toggle the Quick Pick Menu

ShowSquadRoutes

exec function ShowSquadRoutes ()

ShrinkHUD

exec function ShrinkHUD ()

Remove elements from HUD

StartMusic

exec function StartMusic ()

ToggleHUD

exec function ToggleHUD ()

Overrides: HUD.ToggleHUD

Misc / Utility functions

Native functions

DisplayWeaponBar

native function DisplayWeaponBar ()

DrawActorOverlays

native function DrawActorOverlays (Object.Vector Viewpoint, Object.Rotator ViewRotation)

DrawGlowText

native function DrawGlowText (string Text, float X, float Y, optional float MaxHeightInPixels, optional float PulseTime, optional bool bRightJustified)

Draw a glowing string

LinkToHudScene

native function LinkToHudScene ()

This function will attempt to auto-link up HudWidgets to their associated transient property here in the hud.

Events

PostBeginPlay

simulated event PostBeginPlay ()

Overrides: HUD.PostBeginPlay

Create a list of actors needing post renders for. Also Create the Hud Scene

PostRender

event PostRender ()

Overrides: HUD.PostRender

Perform any value precaching, and set up various safe regions

NOTE: NO DRAWING should ever occur in PostRender. Put all drawing code in DrawHud().

Timer

simulated event Timer ()

Overrides: Actor.Timer

Other instance functions

See UTHUD instance functions.