UE2:HUD (UE2Runtime)

From Unreal Wiki, The Unreal Engine Documentation Site
UE2Runtime Object >> Actor >> HUD
Package:
Engine
Direct subclass:
RTHUD
This class in other games:
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

Property group 'HUD'

ConsoleMessagePosX

Type: float


ConsoleMessagePosY

Type: float

DP_LowerLeft

Internal variables

bBadConnectionAlert

Type: bool

display warning about bad connection

bHideCenterMessages

Type: bool

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

bHideHUD

Type: bool


BigFont

Type: Font

Big system font.

Default value: Font'Engine.SmallFont'

bMessageBeep

Type: bool

Modifiers: config


Default value: True

bShowDebugInfo

Type: bool

if true, show properties of current ViewTarget

bShowScores

Type: bool


ConnectingMessage

Type: string

Modifiers: localized


Default value: "CONNECTING"

ConsoleColor

Type: Object.Color


Default value:

Member Value
A 255
B 253
G 216
R 153

ConsoleFontSize

Type: int

Modifiers: globalconfig


Default value: 5

ConsoleMessageCount

Type: int

Modifiers: globalconfig


Default value: 4

FontArrayFonts

Type: Font

Array size: 9


FontArrayNames

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

Type: int

Array size: 9


FontScreenWidthSmall

Type: int

Array size: 9


HudCanvasScale

Type: float

Modifiers: globalconfig

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

Default value: 0.95

HUDConfigWindowType

Type: string


LargeFont

Type: Font

Largest system font.

Default value: Font'Engine.SmallFont'

LoadingMessage

Type: string

Modifiers: localized


Default value: "LOADING"

MedFont

Type: Font

Medium system font.

Default value: Font'Engine.SmallFont'

MessageFontOffset

Type: int

Modifiers: globalconfig


MOTDColor

Type: Object.Color


Default value:

Member Value
A 255
B 255
G 255
R 255

nextHUD

Type: HUD

list of huds which render to the canvas

PausedMessage

Type: string

Modifiers: localized


Default value: "PAUSED"

PlayerOwner

Type: PlayerController

always the actual owner

PrecachingMessage

Type: string

Modifiers: localized


ProgressFadeTime

Type: float


Default value: 1.0

ProgressFontFont

Type: Font


ProgressFontName

Type: string

Modifiers: localized


Default value: "EM_Fonts_T.FontEurostile12"

SavingMessage

Type: string

Modifiers: localized


Default value: "SAVING"

Scoreboard

Type: ScoreBoard


SmallFont

Type: Font

Small system font.

Default value: Font'Engine.SmallFont'

TextMessages

Type: ConsoleMessage

Array size: 8


Default values

Property Value
bHidden True
RemoteRole ROLE_None

Structs

ConsoleMessage

Modifiers: native

string Text
Object.Color TextColor
float MessageLife
PlayerReplicationInfo PRI

HUDLocalizedMessage

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

Static functions

GetConsoleFont

static function Font GetConsoleFont (Canvas C)


GetMediumFontFor

static function Font GetMediumFontFor (Canvas Canvas)


LargerFontThan

static function Font LargerFontThan (Font aFont)


LoadFontStatic

static function Font LoadFontStatic (int i)


Exec functions

ShowDebug

exec function ShowDebug ()


ShowScores

exec function ShowScores ()


Native functions

Draw3DLine

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


Events

ConnectFailure

event ConnectFailure (string FailCode, string URL)


Destroyed

simulated event Destroyed ()

Overrides: Actor.Destroyed


PostBeginPlay

simulated event PostBeginPlay ()

Overrides: Actor.PostBeginPlay


PostRender

simulated event PostRender (Canvas Canvas)


ShowUpgradeMenu

event ShowUpgradeMenu ()


WorldSpaceOverlays

simulated event WorldSpaceOverlays ()


Other instance functions

AddTextMessage

function AddTextMessage (string M, class<LocalMessage> MessageClass, PlayerReplicationInfo PRI)


CheckCountdown

function CheckCountdown (GameReplicationInfo GRI)


ClearMessage

function ClearMessage (out HUDLocalizedMessage M)


CopyMessage

function CopyMessage (out HUDLocalizedMessage M1, HUDLocalizedMessage M2)


DisplayBadConnectionAlert

function DisplayBadConnectionAlert ()


DisplayMessages

function DisplayMessages (Canvas C)


DisplayPortrait

function DisplayPortrait (PlayerReplicationInfo PRI)


DisplayProgressMessage

simulated function DisplayProgressMessage (Canvas C)


DrawHUD

function DrawHUD (Canvas Canvas)


DrawLevelAction

function bool DrawLevelAction (Canvas C)


DrawRoute

simulated function DrawRoute ()


DrawSpectatingHud

function DrawSpectatingHud (Canvas C)


DrawTargeting

simulated function DrawTargeting (Canvas C)


LoadFont

simulated function Font LoadFont (int i)


LoadProgressFont

simulated function Font LoadProgressFont ()


LocalizedMessage

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


Message

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


PlayReceivedMessage

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


PlayStartupMessage

function PlayStartupMessage (byte Stage)


PrintActionMessage

function PrintActionMessage (Canvas C, string BigMessage)


ProcessKeyEvent

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


SpawnScoreBoard

function SpawnScoreBoard (class<ScoreBoard> ScoringType)


UseHugeFont

function UseHugeFont (Canvas Canvas)


UseLargeFont

function UseLargeFont (Canvas Canvas)


UseMediumFont

function UseMediumFont (Canvas Canvas)


UseSmallFont

function UseSmallFont (Canvas Canvas)


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