Gah - a solution with more questions. – EntropicLqd

UE2:HUD (U2XMP)

From Unreal Wiki, The Unreal Engine Documentation Site

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

Contents
Package: 
Engine
Direct subclass:
NullHUD
This class in other games:
RTNP, U1, UDK, UE2Runtime, 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] bMessageBeep

Type: bool

Modifiers: config


Default value: True

[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

Should the hud display itself.

[edit] BigFont

Type: Font

Big system font.

Default value: Font'Engine.SmallFont'

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

Type: float

Array size: 4


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

Type: string

Modifiers: localized


Default value: "SAVING"

[edit] Scoring

Type: ScoreBoard


[edit] SmallFont

Type: Font

Small system font.

Default value: Font'Engine.SmallFont'

[edit] TextMessages

Type: string

Array size: 4


[edit] Default values

Property Value
bHidden True
RemoteRole ROLE_None

[edit] Structs

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


[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 Canvas)


[edit] DisplayProgressMessage

simulated function DisplayProgressMessage (Canvas Canvas)


[edit] DrawHUD

function DrawHUD (Canvas Canvas)


[edit] DrawLevelAction

function bool DrawLevelAction (Canvas C)


[edit] DrawRoute

simulated function DrawRoute ()


[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_(U2XMP)#HUDLocalizedMessage"