HUD¶

Class in Engine · Engine.HUD · native, config, transient

Object › Actor › HUD

Subclasses: DebugCameraHUD, H7Hud, MobileHUD

Using it from Lua

h7.find_all("HUD")            -- live instances
h7.find_class("Engine.HUD")   -- the class
h7.hook("Engine.HUD.AddConsoleMessage", fn)

Structs¶

ConsoleMessage

Field	Type
`Text`	`string`
`TextColor`	`color`
`MessageLife`	`float`
`PRI`	`PlayerReplicationInfo`

HudLocalizedMessage

Field	Type
`Message`	`class<LocalMessage>`
`StringMessage`	`String`
`Switch`	`int`
`EndOfLife`	`float`
`Lifetime`	`float`
`PosY`	`float`
`DrawColor`	`Color`
`FontSize`	`int`
`StringFont`	`Font`
`DX`	`float`
`DY`	`float`
`Drawn`	`bool`
`Count`	`int`
`OptionalObject`	`object`

KismetDrawTextInfo

Field	Type
`MessageText`	`string`
`AppendedText`	`string`
`MessageFont`	`Font`
`MessageFontScale`	`vector2d`
`MessageOffset`	`vector2d`
`MessageColor`	`Color`
`MessageEndTime`	`float`

Properties¶

Name	Type	Notes
`bLostFocusPaused`	`bool`	transient
`bMessageBeep`	`bool`	globalconfig
`bRenderFullScreen`	`bool`
`bScaleCanvasForCinematicMode`	`bool`
`bShowBadConnectionAlert`	`bool`
`bShowDebugInfo`	`bool`
`bShowDirectorInfoDebug`	`bool`	config
`bShowDirectorInfoHUD`	`bool`	config
`bShowHUD`	`bool`	config
`bShowOverlays`	`bool`
`bShowScores`	`bool`
`Canvas`	`Canvas`
`CenterX`	`float`	transient
`CenterY`	`float`	transient
`ConsoleColor`	`Color`	const
`ConsoleFontSize`	`int`	globalconfig
`ConsoleMessageCount`	`int`	config
`ConsoleMessagePosX`	`float`
`ConsoleMessagePosY`	`float`
`ConsoleMessages`	`array<ConsoleMessage>`
`DebugDisplay`	`array`	globalconfig
`GreenColor`	`color`	const
`HudCanvasScale`	`float`	globalconfig
`KismetTextInfo`	`array<KismetDrawTextInfo>`
`LastHUDRenderTime`	`float`	transient
`LocalMessages`	`HudLocalizedMessage[8]`	transient
`MaxHUDAreaMessageCount`	`int`
`MessageFontOffset`	`int`	globalconfig
`PlayerOwner`	`PlayerController`
`PostRenderedActors`	`array<Actor>`
`RatioX`	`float`	transient
`RatioY`	`float`	transient
`RedColor`	`color`	const
`RenderDelta`	`float`	transient
`SizeX`	`float`	transient
`SizeY`	`float`	transient
`WhiteColor`	`color`	const

Functions¶

Name	Declaration
`AddConsoleMessage`	`function AddConsoleMessage(string M, class<LocalMessage> InMessageClass, PlayerReplicationInfo PRI, optional float LifeTime)`
`AddLocalizedMessage`	`function AddLocalizedMessage(int Index, class<LocalMessage> InMessageClass, string CriticalString, int Switch, float Position, float LifeTime, int FontSize, color DrawColor, optional int MessageCount, optional object OptionalObject)`
`AddPostRenderedActor`	`function AddPostRenderedActor(Actor A)`
`ClearMessage`	`function ClearMessage(out HudLocalizedMessage M)`
`DisplayBadConnectionAlert`	`function DisplayBadConnectionAlert()`
`DisplayConsoleMessages`	`function DisplayConsoleMessages()`
`DisplayKismetMessages`	`function DisplayKismetMessages()`
`DisplayLocalMessages`	`function DisplayLocalMessages()`
`Draw2DLine`	`final native function Draw2DLine(int X1, int Y1, int X2, int Y2, color LineColor)`
`Draw3DLine`	`final native function Draw3DLine(vector Start, vector End, color LineColor)`
`DrawActorOverlays`	`native function DrawActorOverlays(vector Viewpoint, rotator ViewRotation)`
`DrawHUD`	`function DrawHUD()`
`DrawMessage`	`function DrawMessage(int i, float PosY, out float DX, out float DY)`
`DrawMessageText`	`function DrawMessageText(HudLocalizedMessage LocalMessage, float ScreenX, float ScreenY)`
`DrawRoute`	`function DrawRoute(Pawn Target)`
`DrawText`	`function DrawText(string Text, vector2d Position, Font TextFont, vector2d FontScale, Color TextColor, optional const out FontRenderInfo RenderInfo)`
`GetFontSizeIndex`	`static function Font GetFontSizeIndex(int FontSize)`
`GetScreenCoords`	`function GetScreenCoords(float PosY, out float ScreenX, out float ScreenY, out HudLocalizedMessage InMessage)`
`LocalizedMessage`	`function LocalizedMessage(class<LocalMessage> InMessageClass, PlayerReplicationInfo RelatedPRI_1, PlayerReplicationInfo RelatedPRI_2, string CriticalString, int Switch, float Position, float LifeTime, int FontSize, color DrawColor, optional object OptionalObject)`
`Message`	`function Message(PlayerReplicationInfo PRI, coerce string Msg, name MsgType, optional float LifeTime)`
`NotifyBindPostProcessEffects`	`function NotifyBindPostProcessEffects()`
`OnLostFocusPause`	`event OnLostFocusPause(bool bEnable)`
`PlayerOwnerDied`	`function PlayerOwnerDied()`
`PostBeginPlay`	`event PostBeginPlay()`
`PostRender`	`event PostRender()`
`PreCalcValues`	`function PreCalcValues()`
`RemovePostRenderedActor`	`function RemovePostRenderedActor(Actor A)`
`SetShowScores`	`exec function SetShowScores(bool bNewValue)`
`ShouldDisplayDebug`	`function bool ShouldDisplayDebug(name DebugType)`
`ShouldShowConsoleMessage`	`function bool ShouldShowConsoleMessage(const ConsoleMessage InConsoleMessage)`
`ShowDebug`	`exec function ShowDebug(optional name DebugType)`
`ShowDebugInfo`	`function ShowDebugInfo(out float out_YL, out float out_YPos)`
`ShowHUD`	`exec function ShowHUD()`
`ShowScores`	`exec function ShowScores()`
`ToggleDirectorInfoDebug`	`exec function ToggleDirectorInfoDebug()`
`ToggleDirectorInfoHUD`	`exec function ToggleDirectorInfoHUD()`
`ToggleHUD`	`exec function ToggleHUD()`

Default values¶

TickGroup=TG_DuringAsyncWork
bHidden=true
RemoteRole=ROLE_None
WhiteColor=(R=255,G=255,B=255,A=255)
ConsoleColor=(R=153,G=216,B=253,A=255)
GreenColor=(R=0,G=255,B=0,A=255)
RedColor=(R=255,G=0,B=0,A=255)
ConsoleMessagePosY=0.8
MaxHUDAreaMessageCount=3
bLostFocusPaused=false
bScaleCanvasForCinematicMode=true
bRenderFullScreen=false

Inherited¶

From	Members
Actor	156 properties, 262 functions
Object	13 properties, 308 functions