My program doesn't have bugs. It just develops random features.

UE2:HUD (U2XMP)

From Unreal Wiki, The Unreal Engine Documentation Site
Revision as of 10:10, 17 May 2008 by Wormbo (Talk | contribs) (Auto-generated page)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search
U2XMP Object >> Actor >> HUD
Package: 
Engine
Direct subclass:
NullHUD
This class in other games:
RTNP, U1, UT, UE2Runtime, UT3, UDK

HUD: Superclass of the heads-up display.

Properties[edit]

Property group 'HUD'[edit]

bMessageBeep[edit]

Type: bool

Modifiers: config


Default value: True

Internal variables[edit]

bBadConnectionAlert[edit]

Type: bool

display warning about bad connection

bHideCenterMessages[edit]

Type: bool

don't draw centered messages (screen center being used)

bHideHUD[edit]

Type: bool

Should the hud display itself.

BigFont[edit]

Type: Font

Big system font.

Default value: Font'Engine.SmallFont'

bShowDebugInfo[edit]

Type: bool

if true, show properties of current ViewTarget

bShowScores[edit]

Type: bool


ConnectingMessage[edit]

Type: string

Modifiers: localized


Default value: "CONNECTING"

HUDConfigWindowType[edit]

Type: string


LargeFont[edit]

Type: Font

Largest system font.

Default value: Font'Engine.SmallFont'

LoadingMessage[edit]

Type: string

Modifiers: localized


Default value: "LOADING"

MedFont[edit]

Type: Font

Medium system font.

Default value: Font'Engine.SmallFont'

MessageLife[edit]

Type: float

Array size: 4


nextHUD[edit]

Type: HUD

list of huds which render to the canvas

PausedMessage[edit]

Type: string

Modifiers: localized


Default value: "PAUSED"

PlayerOwner[edit]

Type: PlayerController

always the actual owner

PrecachingMessage[edit]

Type: string

Modifiers: localized


SavingMessage[edit]

Type: string

Modifiers: localized


Default value: "SAVING"

Scoring[edit]

Type: ScoreBoard


SmallFont[edit]

Type: Font

Small system font.

Default value: Font'Engine.SmallFont'

TextMessages[edit]

Type: string

Array size: 4


Default values[edit]

Property Value
bHidden True
RemoteRole ROLE_None

Structs[edit]

HUDLocalizedMessage[edit]

class<LocalMessage> Message 
int Switch 
PlayerReplicationInfo RelatedPRI 
Object OptionalObject 
float EndOfLife 
float LifeTime 
bool bDrawing 
int numLines 
string StringMessage 
Object.Color DrawColor 
Font StringFont 
float XL 
float YL 
float YPos 

Functions[edit]

Exec functions[edit]

ShowDebug[edit]

exec function ShowDebug ()


ShowScores[edit]

exec function ShowScores ()


Native functions[edit]

Draw3DLine[edit]

native final function Draw3DLine (Object.Vector Start, Object.Vector End, Object.Color LineColor)


Events[edit]

Destroyed[edit]

simulated event Destroyed ()

Overrides: Actor.Destroyed


PostBeginPlay[edit]

simulated event PostBeginPlay ()

Overrides: Actor.PostBeginPlay


PostRender[edit]

simulated event PostRender (Canvas Canvas)


ShowUpgradeMenu[edit]

event ShowUpgradeMenu ()


WorldSpaceOverlays[edit]

simulated event WorldSpaceOverlays ()


Other instance functions[edit]

AddTextMessage[edit]

function AddTextMessage (string M, class<LocalMessageMessageClass)


ClearMessage[edit]

function ClearMessage (out HUDLocalizedMessage M)


CopyMessage[edit]

function CopyMessage (out HUDLocalizedMessage M1, HUDLocalizedMessage M2)


DisplayBadConnectionAlert[edit]

function DisplayBadConnectionAlert ()


DisplayMessages[edit]

function DisplayMessages (Canvas Canvas)


DisplayProgressMessage[edit]

simulated function DisplayProgressMessage (Canvas Canvas)


DrawHUD[edit]

function DrawHUD (Canvas Canvas)


DrawLevelAction[edit]

function bool DrawLevelAction (Canvas C)


DrawRoute[edit]

simulated function DrawRoute ()


LocalizedMessage[edit]

simulated function LocalizedMessage (class<LocalMessageMessage, optional int Switch, optional PlayerReplicationInfo RelatedPRI_1, optional PlayerReplicationInfo RelatedPRI_2, optional Object OptionalObject, optional string CriticalString)


Message[edit]

simulated function Message (PlayerReplicationInfo PRI, coerce string Msg, name MsgType)


PlayReceivedMessage[edit]

simulated function PlayReceivedMessage (string S, string PName, ZoneInfo PZone)


PlayStartupMessage[edit]

function PlayStartupMessage (byte Stage)


PrintActionMessage[edit]

function PrintActionMessage (Canvas C, string BigMessage)


ProcessKeyEvent[edit]

function bool ProcessKeyEvent (int Key, int Action, float Delta)


SpawnScoreBoard[edit]

function SpawnScoreBoard (class<ScoreBoardScoringType)


UseHugeFont[edit]

function UseHugeFont (Canvas Canvas)


UseLargeFont[edit]

function UseLargeFont (Canvas Canvas)


UseMediumFont[edit]

function UseMediumFont (Canvas Canvas)


UseSmallFont[edit]

function UseSmallFont (Canvas Canvas)