The three virtues of a programmer: Laziness, Impatience, and Hubris. – Larry Wall

UE2:HUD (U2XMP)

From Unreal Wiki, The Unreal Engine Documentation Site
Revision as of 09: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

Property group 'HUD'

bMessageBeep

Type: bool

Modifiers: config


Default value: True

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

Should the hud display itself.

BigFont

Type: Font

Big system font.

Default value: Font'Engine.SmallFont'

bShowDebugInfo

Type: bool

if true, show properties of current ViewTarget

bShowScores

Type: bool


ConnectingMessage

Type: string

Modifiers: localized


Default value: "CONNECTING"

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'

MessageLife

Type: float

Array size: 4


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


SavingMessage

Type: string

Modifiers: localized


Default value: "SAVING"

Scoring

Type: ScoreBoard


SmallFont

Type: Font

Small system font.

Default value: Font'Engine.SmallFont'

TextMessages

Type: string

Array size: 4


Default values

Property Value
bHidden True
RemoteRole ROLE_None

Structs

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

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

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


ClearMessage

function ClearMessage (out HUDLocalizedMessage M)


CopyMessage

function CopyMessage (out HUDLocalizedMessage M1, HUDLocalizedMessage M2)


DisplayBadConnectionAlert

function DisplayBadConnectionAlert ()


DisplayMessages

function DisplayMessages (Canvas Canvas)


DisplayProgressMessage

simulated function DisplayProgressMessage (Canvas Canvas)


DrawHUD

function DrawHUD (Canvas Canvas)


DrawLevelAction

function bool DrawLevelAction (Canvas C)


DrawRoute

simulated function DrawRoute ()


LocalizedMessage

simulated function LocalizedMessage (class<LocalMessageMessage, 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<ScoreBoardScoringType)


UseHugeFont

function UseHugeFont (Canvas Canvas)


UseLargeFont

function UseLargeFont (Canvas Canvas)


UseMediumFont

function UseMediumFont (Canvas Canvas)


UseSmallFont

function UseSmallFont (Canvas Canvas)