Mostly Harmless

UE2:HUD (UE2Runtime)

From Unreal Wiki, The Unreal Engine Documentation Site

Jump to: navigation, search
UE2Runtime Object >> Actor >> HUD

Contents
Package: 
Engine
Direct subclass:
RTHUD
This class in other games:
RTNP, U1, U2XMP, UDK, UT, UT3
This is an auto-generated page and may need human attention.
Please remove this 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.

[edit] Properties

[edit] Property group 'HUD'

[edit] ConsoleMessagePosX

Type: float


[edit] ConsoleMessagePosY

Type: float

DP_LowerLeft

[edit] Internal variables

[edit] bBadConnectionAlert

Type: bool

display warning about bad connection

[edit] bHideCenterMessages

Type: bool

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

[edit] bHideHUD

Type: bool


[edit] BigFont

Type: Font

Big system font.

Default value: Font'Engine.SmallFont'

[edit] bMessageBeep

Type: bool

Modifiers: config


Default value: True

[edit] bShowDebugInfo

Type: bool

if true, show properties of current ViewTarget

[edit] bShowScores

Type: bool


[edit] ConnectingMessage

Type: string

Modifiers: localized


Default value: "CONNECTING"

[edit] ConsoleColor

Type: Object.Color


Default value:

Member Value
A 255
B 253
G 216
R 153

[edit] ConsoleFontSize

Type: int

Modifiers: globalconfig


Default value: 5

[edit] ConsoleMessageCount

Type: int

Modifiers: globalconfig


Default value: 4

[edit] FontArrayFonts

Type: Font

Array size: 9


[edit] 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"

[edit] FontScreenWidthMedium

Type: int

Array size: 9


[edit] FontScreenWidthSmall

Type: int

Array size: 9


[edit] HudCanvasScale

Type: float

Modifiers: globalconfig

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

Default value: 0.95

[edit] HUDConfigWindowType

Type: string


[edit] LargeFont

Type: Font

Largest system font.

Default value: Font'Engine.SmallFont'

[edit] LoadingMessage

Type: string

Modifiers: localized


Default value: "LOADING"

[edit] MedFont

Type: Font

Medium system font.

Default value: Font'Engine.SmallFont'

[edit] MessageFontOffset

Type: int

Modifiers: globalconfig


[edit] MOTDColor

Type: Object.Color


Default value:

Member Value
A 255
B 255
G 255
R 255

[edit] nextHUD

Type: HUD

list of huds which render to the canvas

[edit] PausedMessage

Type: string

Modifiers: localized


Default value: "PAUSED"

[edit] PlayerOwner

Type: PlayerController

always the actual owner

[edit] PrecachingMessage

Type: string

Modifiers: localized


[edit] ProgressFadeTime

Type: float


Default value: 1.0

[edit] ProgressFontFont

Type: Font


[edit] ProgressFontName

Type: string

Modifiers: localized


Default value: "EM_Fonts_T.FontEurostile12"

[edit] SavingMessage

Type: string

Modifiers: localized


Default value: "SAVING"

[edit] Scoreboard

Type: ScoreBoard


[edit] SmallFont

Type: Font

Small system font.

Default value: Font'Engine.SmallFont'

[edit] TextMessages

Type: ConsoleMessage

Array size: 8


[edit] Default values

Property Value
bHidden True
RemoteRole ROLE_None

[edit] Structs

[edit] ConsoleMessage

Modifiers: native

string Text 
Object.Color TextColor 
float MessageLife 
PlayerReplicationInfo PRI 

[edit] 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 

[edit] Functions

[edit] Static functions

[edit] GetConsoleFont

static function Font GetConsoleFont (Canvas C)


[edit] GetMediumFontFor

static function Font GetMediumFontFor (Canvas Canvas)


[edit] LargerFontThan

static function Font LargerFontThan (Font aFont)


[edit] LoadFontStatic

static function Font LoadFontStatic (int i)


[edit] Exec functions

[edit] ShowDebug

exec function ShowDebug ()


[edit] ShowScores

exec function ShowScores ()


[edit] Native functions

[edit] Draw3DLine

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


[edit] Events

[edit] ConnectFailure

event ConnectFailure (string FailCode, string URL)


[edit] Destroyed

simulated event Destroyed ()

Overrides: Actor.Destroyed


[edit] PostBeginPlay

simulated event PostBeginPlay ()

Overrides: Actor.PostBeginPlay


[edit] PostRender

simulated event PostRender (Canvas Canvas)


[edit] ShowUpgradeMenu

event ShowUpgradeMenu ()


[edit] WorldSpaceOverlays

simulated event WorldSpaceOverlays ()


[edit] Other instance functions

[edit] AddTextMessage

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


[edit] CheckCountdown

function CheckCountdown (GameReplicationInfo GRI)


[edit] ClearMessage

function ClearMessage (out HUDLocalizedMessage M)


[edit] CopyMessage

function CopyMessage (out HUDLocalizedMessage M1, HUDLocalizedMessage M2)


[edit] DisplayBadConnectionAlert

function DisplayBadConnectionAlert ()


[edit] DisplayMessages

function DisplayMessages (Canvas C)


[edit] DisplayPortrait

function DisplayPortrait (PlayerReplicationInfo PRI)


[edit] DisplayProgressMessage

simulated function DisplayProgressMessage (Canvas C)


[edit] DrawHUD

function DrawHUD (Canvas Canvas)


[edit] DrawLevelAction

function bool DrawLevelAction (Canvas C)


[edit] DrawRoute

simulated function DrawRoute ()


[edit] DrawSpectatingHud

function DrawSpectatingHud (Canvas C)


[edit] DrawTargeting

simulated function DrawTargeting (Canvas C)


[edit] LoadFont

simulated function Font LoadFont (int i)


[edit] LoadProgressFont

simulated function Font LoadProgressFont ()


[edit] LocalizedMessage

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


[edit] Message

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


[edit] PlayReceivedMessage

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


[edit] PlayStartupMessage

function PlayStartupMessage (byte Stage)


[edit] PrintActionMessage

function PrintActionMessage (Canvas C, string BigMessage)


[edit] ProcessKeyEvent

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


[edit] SpawnScoreBoard

function SpawnScoreBoard (class<ScoreBoard> ScoringType)


[edit] UseHugeFont

function UseHugeFont (Canvas Canvas)


[edit] UseLargeFont

function UseLargeFont (Canvas Canvas)


[edit] UseMediumFont

function UseMediumFont (Canvas Canvas)


[edit] UseSmallFont

function UseSmallFont (Canvas Canvas)


Retrieved from "http://wiki.beyondunreal.com/UE2:HUD_(UE2Runtime)#ConsoleMessage"