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

UE2:Hud (UT2003)

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
UT2003 Object >> Actor >> Hud

Contents

Package: 
Engine
Direct subclasses:
CinematicHud, HudBase
This class in other games:
UT2004

null

Properties

Property group 'Hud'

bCrosshairShow

Type: bool

Modifiers: globalconfig


Default value: True

bHideHUD

Type: bool

Modifiers: globalconfig


bMessageBeep

Type: bool

Modifiers: globalconfig


Default value: True

bShowBadConnectionAlert

Type: bool

Display indication of bad connection

bShowDebugInfo

Type: bool

if true, show properties of current ViewTarget

bShowPersonalInfo

Type: bool

Modifiers: globalconfig


Default value: True

bShowPoints

Type: bool

Modifiers: globalconfig


Default value: True

bShowPortrait

Type: bool

Modifiers: globalconfig


Default value: True

bShowScoreBoard

Type: bool

Display current score-board instead of Hud elements

bShowVoteMenu

Type: bool


bShowWeaponBar

Type: bool

Modifiers: globalconfig


Default value: True

bShowWeaponInfo

Type: bool

Modifiers: globalconfig


Default value: True

ConsoleColor

Type: Object.Color


Default value:

Member Value
A 255
B 253
G 216
R 153

ConsoleMessagePosX

Type: float


ConsoleMessagePosY

Type: float

DP_LowerLeft

Default value: 1.0

CrossHairColor

Type: Object.Color

Modifiers: globalconfig


Default value:

Member Value
A 255
B 255
G 255
R 255

CrosshairOpacity

Type: float

Modifiers: globalconfig


Default value: 1.0

CrosshairScale

Type: float

Modifiers: globalconfig


Default value: 1.0

CrosshairStyle

Type: int

Modifiers: globalconfig


HudCanvasScale

Type: float

Modifiers: globalconfig

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

Default value: 0.95

HudOpacity

Type: float

Modifiers: globalconfig

make everything transparent

Default value: 255.0

HudScale

Type: float

Modifiers: globalconfig

Global Scale for all widgets

Default value: 1.0

LocalStatsScreen

Type: ScoreBoard


MOTDColor

Type: Object.Color


Default value:

Member Value
A 255
B 255
G 255
R 255

OverrideConsoleFont

Type: Font


OverrideConsoleFontName

Type: string

Modifiers: localized


PawnOwner

Type: Pawn


PawnOwnerPRI

Type: PlayerReplicationInfo


PlayerConsole

Type: Console


PlayerOwner

Type: PlayerController


ProgressFadeTime

Type: float


Default value: 1.0

ProgressFontFont

Type: Font


ProgressFontName

Type: string

Modifiers: localized


Default value: "UT2003Fonts.FontEurostile12"

ScoreBoard

Type: ScoreBoard


VoteMenu

Type: Actor

hook for mod authors

Internal variables

bBuiltMOTD

Type: bool

Set to true when the MOTD has been set

BlueColor

Type: Object.Color


Default value:

Member Value
A 255
B 255
G 0
R 0

bNoEnemyNames

Type: bool

Modifiers: globalconfig


bShowLocalStats

Type: bool


ConsoleFontSize

Type: int

Modifiers: globalconfig


Default value: 5

ConsoleMessageCount

Type: int

Modifiers: globalconfig


Default value: 4

CyanColor

Type: Object.Color


Default value:

Member Value
A 255
B 255
G 255
R 0

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


GoldColor

Type: Object.Color


Default value:

Member Value
A 255
B 0
G 255
R 255

GrayColor

Type: Object.Color


Default value:

Member Value
A 255
B 200
G 200
R 200

GreenColor

Type: Object.Color


Default value:

Member Value
A 255
B 0
G 255
R 0

MessageFontOffset

Type: int

Modifiers: globalconfig


MOTD

Type: string

Array size: 4

Holds the expanded MOTD Lines

MOTDState

Type: int


PurpleColor

Type: Object.Color


Default value:

Member Value
A 255
B 255
G 0
R 255

RedColor

Type: Object.Color


Default value:

Member Value
A 255
B 0
G 0
R 255

ResScaleX

Type: float

Modifiers: transient


ResScaleY

Type: float

Modifiers: transient


TextMessages

Type: ConsoleMessage

Array size: 8


TurqColor

Type: Object.Color


Default value:

Member Value
A 255
B 255
G 128
R 0

WhiteColor

Type: Object.Color


Default value:

Member Value
A 255
B 255
G 255
R 255

Default values

Property Value
bHidden True
RemoteRole ROLE_None

Structs

ConsoleMessage

string Text 
Object.Color TextColor 
float MessageLife 
PlayerReplicationInfo PRI 

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

GrowHUD

exec function GrowHUD ()


NextStats

exec function NextStats ()


ShowDebug

exec function ShowDebug ()


ShowHud

exec function ShowHud ()


ShowScores

exec function ShowScores ()


ShowStats

exec function ShowStats ()


ShrinkHUD

exec function ShrinkHUD ()


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)


WorldSpaceOverlays

simulated event WorldSpaceOverlays ()


Other instance functions

AddTextMessage

function AddTextMessage (string M, class<LocalMessageMessageClass, PlayerReplicationInfo PRI)


BuildMOTD

simulated function BuildMOTD ()


CheckCountdown

function CheckCountdown (GameReplicationInfo GRI)


CreateKeyMenus

simulated function CreateKeyMenus ()


DisplayBadConnectionAlert

function DisplayBadConnectionAlert (Canvas C)


DisplayMessages

function DisplayMessages (Canvas C)


DisplayPortrait

function DisplayPortrait (PlayerReplicationInfo PRI)


DisplayProgressMessages

simulated function DisplayProgressMessages (Canvas C)


DrawCrosshair

simulated function DrawCrosshair (Canvas C)


DrawHud

function DrawHud (Canvas C)


DrawInstructionGfx

simulated function DrawInstructionGfx (Canvas C)


DrawLevelAction

function bool DrawLevelAction (Canvas C)


DrawRoute

simulated function DrawRoute ()


DrawSpectatingHud

function DrawSpectatingHud (Canvas C)


DrawTargeting

simulated function DrawTargeting (Canvas C)


DrawTypingPrompt

simulated function DrawTypingPrompt (Canvas C, string Text)


GetFontSizeIndex

function Font GetFontSizeIndex (Canvas C, int FontSize)


GetLocalStatsScreen

function GetLocalStatsScreen ()


LinkActors

simulated function LinkActors ()


LoadFont

simulated function Font LoadFont (int i)


LoadProgressFont

simulated function Font LoadProgressFont ()


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)


Reset

function Reset ()

Overrides: Actor.Reset


SetCropping

simulated function SetCropping (bool Active)


SetInstructionKeyText

simulated function SetInstructionKeyText (string text)


SetInstructionText

simulated function SetInstructionText (string text)


SetScoreBoardClass

simulated function SetScoreBoardClass (class<ScoreBoardScoreBoardClass)


SetTargeting

simulated function SetTargeting (bool bShow, optional Object.Vector TargetLocation, optional float Size)