There is no spoon

From Unreal Wiki, The Unreal Engine Documentation Site

Object >> Actor >> HUD

Package: 

Engine

Direct subclasses:

DebugCameraHUD, GameHUD, ScoreBoard

This class in other games:

RTNP, U1, U2XMP, UDK, UE2Runtime, UT

HUD: Superclass of the heads-up display.

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

[edit] Properties

[edit] Property group 'HUD'

[edit] bShowBadConnectionAlert

Type: bool

Display indication of bad connection

[edit] ConsoleMessagePosX

Type: float

[edit] ConsoleMessagePosY

Type: float

DP_LowerLeft

Default value: 0.8

[edit] LocalMessages

Type: HudLocalizedMessage

Array size: 8

Modifiers: transient

[edit] Internal variables

[edit] bMessageBeep

Type: bool

Modifiers: globalconfig

If true, any console messages will make a beep

Default value: True

[edit] bShowDebugInfo

Type: bool

if true, show properties of current ViewTarget

[edit] bShowHUD

Type: bool

Modifiers: config

Is the hud visible

Default value: True

[edit] bShowScores

Type: bool

Is the Scoreboard visible

[edit] Canvas

Type: Canvas

Canvas to Draw HUD on. NOTE: a new Canvas is given every frame, only draw on it from the HUD::PostRender() event

[edit] CenterX

Type: float

Modifiers: transient

Center of Viewport

[edit] CenterY

Type: float

Modifiers: transient

Center of Viewport

[edit] ConsoleColor

Type: Object.Color

Modifiers: const

Default value:

[edit] ConsoleFontSize

Type: int

Modifiers: globalconfig

Default value: 5

[edit] ConsoleMessageCount

Type: int

Modifiers: globalconfig

Default value: 4

[edit] ConsoleMessages

Type: array<ConsoleMessage>

[edit] DebugDisplay

Type: array<name>

Modifiers: globalconfig

Default value: 'AI'

[edit] GreenColor

Type: Object.Color

Modifiers: const

Default value:

[edit] HudCanvasScale

Type: float

Modifiers: globalconfig

Default value: 0.95

[edit] HudOwner

Type: HUD

Used for sub-huds like the scoreboard

[edit] LastHUDRenderTime

Type: float

Modifiers: transient

Used to create DeltaTime

[edit] LostFocusPaused

Type: bool

Modifiers: transient

Tells whether the game was paused due to lost focus

[edit] MaxHUDAreaMessageCount

Type: int

Default value: 3

[edit] MessageFontOffset

Type: int

Modifiers: globalconfig

[edit] MOTDColor

Type: Object.Color

Default value:

[edit] PlayerOwner

Type: PlayerController

always the actual owner

[edit] ProgressFadeTime

Type: float

Default value: 1.0

[edit] RatioX

Type: float

Modifiers: transient

Ratio of viewport compared to native resolution 1024x768

[edit] RatioY

Type: float

Modifiers: transient

Ratio of viewport compared to native resolution 1024x768

[edit] RedColor

Type: Object.Color

Modifiers: const

Default value:

[edit] RenderDelta

Type: float

Modifiers: transient

Time since last render

[edit] Scoreboard

Type: ScoreBoard

[edit] SizeX

Type: float

Modifiers: transient

Size of ViewPort in pixels

[edit] SizeY

Type: float

Modifiers: transient

Size of ViewPort in pixels

[edit] ViewedInfo

Type: PlayerReplicationInfo

The PRI of the current view target

[edit] WhiteColor

Type: Object.Color

Modifiers: const

Default value:

[edit] Default values

[edit] Structs

[edit] ConsoleMessage

Modifiers: native

string Text 

Object.Color TextColor 

float MessageLife 

PlayerReplicationInfo PRI 

[edit] HudLocalizedMessage

Modifiers: native

class<LocalMessage> Message 

string StringMessage 

int Switch 

float EndOfLife 

float Lifetime 

float PosY 

Object.Color DrawColor 

int FontSize 

Font StringFont 

float DX 

float DY 

bool Drawn 

int Count 

Object OptionalObject 

[edit] Functions

[edit] Static functions

[edit] GetFontSizeIndex

[edit] GetRYGColorRamp

[edit] Exec functions

[edit] FXPlay

Finds the nearest pawn of the given class (excluding the owner's pawn) and plays the specified FaceFX animation.

[edit] FXStop

Finds the nearest pawn of the given class (excluding the owner's pawn) and stops any currently playing FaceFX animation.

[edit] SetShowScores

sets bShowScores to a specific value (not toggle)

[edit] ShowDebug

[edit] ShowHUD

[edit] ShowScores

[edit] ToggleHUD

[edit] Native functions

[edit] Draw2DLine

[edit] Draw3DLine

[edit] Events

[edit] Destroyed

Overrides: Actor.Destroyed

[edit] OnLostFocusPause

Pauses or unpauses the game due to main window's focus being lost.

Parameters:

• Enable - tells whether to enable or disable the pause state

[edit] PostBeginPlay

Overrides: Actor.PostBeginPlay

[edit] PostRender

PostRender is the main draw loop.

[edit] Other instance functions

[edit] AddConsoleMessage

Add a new console message to display.

[edit] AddLocalizedMessage

Add the actual message to the array. Made easier to tweak in a subclass

Parameters:

• Index - The index in to the LocalMessages array to place it.
• InMessageClass - Class of the message
• CriticialString - String of the message
• Switch - The message switch
• Position - Where on the screen is the message
• LifeTime - How long does this message live
• FontSize - How big is the message
• DrawColor - The Color of the message

[edit] ClearMessage

[edit] DisplayBadConnectionAlert

[edit] DisplayConsoleMessages

Display current messages

[edit] DisplayLocalMessages

[edit] DisplayProgressMessage

display progress messages in center of screen

[edit] DrawDemoHUD

Called instead of DrawHUD() if bShowHUD==false

[edit] DrawEngineHUD

Special HUD for Engine demo

[edit] DrawHUD

The Main Draw loop for the hud. Gets called before any messaging. Should be subclassed

[edit] DrawMessage

[edit] DrawMessageText

[edit] DrawRoute

[edit] GetScreenCoords

[edit] LocalizedMessage

[edit] Message

[edit] PlayerOwnerDied

Called when the player owner has died.

[edit] PreCalcValues

Pre-Calculate most common values, to avoid doing 1200 times the same operations

[edit] ShouldDisplayDebug

[edit] SpawnScoreBoard