Mostly Harmless

UE2:HUD (UE2Runtime)

From Unreal Wiki, The Unreal Engine Documentation Site
(Redirected from UE2:Hud (UE2Runtime))
Jump to: navigation, search
UE2Runtime Object >> Actor >> HUD

Contents

Package: 
Engine
Direct subclass:
RTHUD
This class in other games:
RTNP, U1, UT, U2XMP, UT3, UDK
This is an auto-generated page and may need human attention.
Please remove the {{autogenerated}} tag if the page seems reasonably complete or replace it with the {{expand}} tag if the page is not yet complete.

HUD: Superclass of the heads-up display.

Properties[edit]

Property group 'HUD'[edit]

ConsoleMessagePosX[edit]

Type: float


ConsoleMessagePosY[edit]

Type: float

DP_LowerLeft

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


BigFont[edit]

Type: Font

Big system font.

Default value: Font'Engine.SmallFont'

bMessageBeep[edit]

Type: bool

Modifiers: config


Default value: True

bShowDebugInfo[edit]

Type: bool

if true, show properties of current ViewTarget

bShowScores[edit]

Type: bool


ConnectingMessage[edit]

Type: string

Modifiers: localized


Default value: "CONNECTING"

ConsoleColor[edit]

Type: Object.Color


Default value:

Member Value
A 255
B 253
G 216
R 153

ConsoleFontSize[edit]

Type: int

Modifiers: globalconfig


Default value: 5

ConsoleMessageCount[edit]

Type: int

Modifiers: globalconfig


Default value: 4

FontArrayFonts[edit]

Type: Font

Array size: 9


FontArrayNames[edit]

Type: string

Array size: 9

Modifiers: localized


Default value, index 0: "Engine.DefaultFont"

Default value, index 1: "Engine.DefaultFont"

Default value, index 2: "Engine.DefaultFont"

Default value, index 3: "Engine.DefaultFont"

Default value, index 4: "Engine.DefaultFont"

Default value, index 5: "Engine.DefaultFont"

Default value, index 6: "Engine.DefaultFont"

Default value, index 7: "Engine.DefaultFont"

Default value, index 8: "Engine.DefaultFont"

FontScreenWidthMedium[edit]

Type: int

Array size: 9


FontScreenWidthSmall[edit]

Type: int

Array size: 9


HudCanvasScale[edit]

Type: float

Modifiers: globalconfig

Specifies amount of screen-space to use (for TV's).

Default value: 0.95

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'

MessageFontOffset[edit]

Type: int

Modifiers: globalconfig


MOTDColor[edit]

Type: Object.Color


Default value:

Member Value
A 255
B 255
G 255
R 255

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


ProgressFadeTime[edit]

Type: float


Default value: 1.0

ProgressFontFont[edit]

Type: Font


ProgressFontName[edit]

Type: string

Modifiers: localized


Default value: "EM_Fonts_T.FontEurostile12"

SavingMessage[edit]

Type: string

Modifiers: localized


Default value: "SAVING"

Scoreboard[edit]

Type: ScoreBoard


SmallFont[edit]

Type: Font

Small system font.

Default value: Font'Engine.SmallFont'

TextMessages[edit]

Type: ConsoleMessage

Array size: 8


Default values[edit]

Property Value
bHidden True
RemoteRole ROLE_None

Structs[edit]

ConsoleMessage[edit]

Modifiers: native

string Text 
Object.Color TextColor 
float MessageLife 
PlayerReplicationInfo PRI 

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]

Static functions[edit]

GetConsoleFont[edit]

static function Font GetConsoleFont (Canvas C)


GetMediumFontFor[edit]

static function Font GetMediumFontFor (Canvas Canvas)


LargerFontThan[edit]

static function Font LargerFontThan (Font aFont)


LoadFontStatic[edit]

static function Font LoadFontStatic (int i)


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]

ConnectFailure[edit]

event ConnectFailure (string FailCode, string URL)


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<LocalMessage> MessageClass, PlayerReplicationInfo PRI)


CheckCountdown[edit]

function CheckCountdown (GameReplicationInfo GRI)


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 C)


DisplayPortrait[edit]

function DisplayPortrait (PlayerReplicationInfo PRI)


DisplayProgressMessage[edit]

simulated function DisplayProgressMessage (Canvas C)


DrawHUD[edit]

function DrawHUD (Canvas Canvas)


DrawLevelAction[edit]

function bool DrawLevelAction (Canvas C)


DrawRoute[edit]

simulated function DrawRoute ()


DrawSpectatingHud[edit]

function DrawSpectatingHud (Canvas C)


DrawTargeting[edit]

simulated function DrawTargeting (Canvas C)


LoadFont[edit]

simulated function Font LoadFont (int i)


LoadProgressFont[edit]

simulated function Font LoadProgressFont ()


LocalizedMessage[edit]

simulated function LocalizedMessage (class<LocalMessage> Message, 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<ScoreBoard> ScoringType)


UseHugeFont[edit]

function UseHugeFont (Canvas Canvas)


UseLargeFont[edit]

function UseLargeFont (Canvas Canvas)


UseMediumFont[edit]

function UseMediumFont (Canvas Canvas)


UseSmallFont[edit]

function UseSmallFont (Canvas Canvas)


Retrieved from "https://wiki.beyondunreal.com/UE2:HUD_(UE2Runtime)?oldid=20366"