There is no spoon

Difference between revisions of "UE3:UTHUD (UT3)"

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
(Auto-generated page)
 
(added descriptions)
Line 6: Line 6:
 
| parent4 = Object
 
| parent4 = Object
 
}}
 
}}
−
{{autogenerated}}
+
The HUD class for Deathmatch and the base for all UT3 gametype HUDs.
−
UTHUD
+
−
UT Heads Up Display
+
−
 
+
−
 
+
−
Copyright 1998-2007 Epic Games, Inc. All Rights Reserved.
+
  
 
==Properties==
 
==Properties==
Line 20: Line 15:
 
'''[[Structs#Modifiers|Modifiers]]:''' native
 
'''[[Structs#Modifiers|Modifiers]]:''' native
  
−
Holds the various data for each Damage Type
+
Holds data for directional damage indicators.
−
; [[float]] FadeTime : <!-- enter variable description -->
+
; [[float]] FadeTime : Time for fade-out.
−
; [[float]] FadeValue : <!-- enter variable description -->
+
; [[float]] FadeValue : Current fade value.
−
; {{cl|MaterialInstanceConstant}} MatConstant : <!-- enter variable description -->
+
; {{cl|MaterialInstanceConstant}} MatConstant : The MIC for this indicator.
  
 
==Functions==
 
==Functions==
Line 36: Line 31:
 
{{code|static simulated function '''DrawBackground''' ([[float]]&nbsp;'''X''', [[float]]&nbsp;'''Y''', [[float]]&nbsp;'''Width''', [[float]]&nbsp;'''Height''', {{tl|LinearColor|Object|structs}}&nbsp;'''DrawColor''', {{cl|Canvas}}&nbsp;'''DrawCanvas''')}}
 
{{code|static simulated function '''DrawBackground''' ([[float]]&nbsp;'''X''', [[float]]&nbsp;'''Y''', [[float]]&nbsp;'''Width''', [[float]]&nbsp;'''Height''', {{tl|LinearColor|Object|structs}}&nbsp;'''DrawColor''', {{cl|Canvas}}&nbsp;'''DrawCanvas''')}}
  
−
<!-- enter function description -->
+
Draws the background of player, vehicle and objective beacons.
  
 
====DrawBarGraph====
 
====DrawBarGraph====
 
{{code|static simulated function '''DrawBarGraph''' ([[float]]&nbsp;'''X''', [[float]]&nbsp;'''Y''', [[float]]&nbsp;'''Width''', [[float]]&nbsp;'''MaxWidth''', [[float]]&nbsp;'''Height''', {{cl|Canvas}}&nbsp;'''DrawCanvas''', {{tl|Color|Object|structs}}&nbsp;'''BarColor''', {{tl|Color|Object|structs}}&nbsp;'''BackColor''')}}
 
{{code|static simulated function '''DrawBarGraph''' ([[float]]&nbsp;'''X''', [[float]]&nbsp;'''Y''', [[float]]&nbsp;'''Width''', [[float]]&nbsp;'''MaxWidth''', [[float]]&nbsp;'''Height''', {{cl|Canvas}}&nbsp;'''DrawCanvas''', {{tl|Color|Object|structs}}&nbsp;'''BarColor''', {{tl|Color|Object|structs}}&nbsp;'''BackColor''')}}
  
−
<!-- enter function description -->
+
Draws a horizontal bar graph, e.g. for player health.
  
 
====DrawHealth====
 
====DrawHealth====
 
{{code|static simulated function '''DrawHealth''' ([[float]]&nbsp;'''X''', [[float]]&nbsp;'''Y''', [[float]]&nbsp;'''Width''', [[float]]&nbsp;'''MaxWidth''', [[float]]&nbsp;'''Height''', {{cl|Canvas}}&nbsp;'''DrawCanvas''', optional&nbsp;[[byte]]&nbsp;'''Alpha''')}}
 
{{code|static simulated function '''DrawHealth''' ([[float]]&nbsp;'''X''', [[float]]&nbsp;'''Y''', [[float]]&nbsp;'''Width''', [[float]]&nbsp;'''MaxWidth''', [[float]]&nbsp;'''Height''', {{cl|Canvas}}&nbsp;'''DrawCanvas''', optional&nbsp;[[byte]]&nbsp;'''Alpha''')}}
  
−
Draw a beacon healthbar
+
Wrapper function for {{tl|DrawBarGraph}}() specifically for health-like graphs.
−
 
+
−
'''Parameters:'''
+
−
* ''Width'' - is the actual health width
+
−
* ''MaxWidth'' - corresponds to the max health
+
  
 
====FormatTime====
 
====FormatTime====
 
{{code|static function [[string]]&nbsp;'''FormatTime''' ([[int]]&nbsp;'''Seconds''')}}
 
{{code|static function [[string]]&nbsp;'''FormatTime''' ([[int]]&nbsp;'''Seconds''')}}
  
−
Creates a string from the time
+
Converts the number of seconds into a time string of the form HH:MM:SS.
  
 
====GetFontSizeIndex====
 
====GetFontSizeIndex====
Line 62: Line 53:
 
'''Overrides:''' {{tl|GetFontSizeIndex|HUD}}
 
'''Overrides:''' {{tl|GetFontSizeIndex|HUD}}
  
−
<!-- enter function description -->
+
Returns a font from the default {{tl|HudFonts||UTHUD properties}} array. Valid font sizes range from 0 to 3, values outside the range are clamped to the nearest valid value.
  
 
====GetTeamColor====
 
====GetTeamColor====
 
{{code|static simulated function '''GetTeamColor''' ([[int]]&nbsp;'''TeamIndex''', optional&nbsp;out&nbsp;{{tl|LinearColor|Object|structs}}&nbsp;'''ImageColor''', optional&nbsp;out&nbsp;{{tl|Color|Object|structs}}&nbsp;'''TextColor''')}}
 
{{code|static simulated function '''GetTeamColor''' ([[int]]&nbsp;'''TeamIndex''', optional&nbsp;out&nbsp;{{tl|LinearColor|Object|structs}}&nbsp;'''ImageColor''', optional&nbsp;out&nbsp;{{tl|Color|Object|structs}}&nbsp;'''TextColor''')}}
  
−
<!-- enter function description -->
+
Returns image color red for team 0, blue for team 1 and white for any other team index. Always returns "light gold" (a pale yellow) as the text color.
  
 
===Exec functions===
 
===Exec functions===
Line 73: Line 64:
 
{{code|exec function '''GrowHUD''' ()}}
 
{{code|exec function '''GrowHUD''' ()}}
  
−
Add missing elements to HUD
+
Adds missing elements to HUD.
  
 
====ReleaseShowScores====
 
====ReleaseShowScores====
 
{{code|exec function '''ReleaseShowScores''' ()}}
 
{{code|exec function '''ReleaseShowScores''' ()}}
  
−
<!-- enter function description -->
+
Hides the scoreboard.
  
 
====SetShowScores====
 
====SetShowScores====
Line 85: Line 76:
 
'''Overrides:''' {{tl|SetShowScores|HUD}}
 
'''Overrides:''' {{tl|SetShowScores|HUD}}
  
−
sets bShowScores to a specific value (not toggle)
+
Shows or hides the scoreboard according to the parameter value.
  
 
====ShowAllAI====
 
====ShowAllAI====
 
{{code|exec function '''ShowAllAI''' ()}}
 
{{code|exec function '''ShowAllAI''' ()}}
  
−
<!-- enter function description -->
+
Toggles whether AI information should be drawn for each bot {{cl|Pawn}}.
  
 
====ShowQuickPickMenu====
 
====ShowQuickPickMenu====
 
{{code|exec function '''ShowQuickPickMenu''' ([[bool]]&nbsp;'''bShow''')}}
 
{{code|exec function '''ShowQuickPickMenu''' ([[bool]]&nbsp;'''bShow''')}}
  
−
Toggle the Quick Pick Menu
+
Shows or hides the Quick Pick Menu according to the parameter value.
  
 
====ShowSquadRoutes====
 
====ShowSquadRoutes====
 
{{code|exec function '''ShowSquadRoutes''' ()}}
 
{{code|exec function '''ShowSquadRoutes''' ()}}
  
−
<!-- enter function description -->
+
Renders all squad routes of the currently spectated bot as persistent lines in the level. Each route gets a random color.
  
 
====ShrinkHUD====
 
====ShrinkHUD====
 
{{code|exec function '''ShrinkHUD''' ()}}
 
{{code|exec function '''ShrinkHUD''' ()}}
  
−
Remove elements from HUD
+
Removes elements from HUD.
  
 
====StartMusic====
 
====StartMusic====
 
{{code|exec function '''StartMusic''' ()}}
 
{{code|exec function '''StartMusic''' ()}}
  
−
<!-- enter function description -->
+
Creates a {{cl|UTMusicManager}} for the player, unless there already is a music manager for that player.
  
 
====ToggleHUD====
 
====ToggleHUD====
Line 117: Line 108:
 
'''Overrides:''' {{tl|ToggleHUD|HUD}}
 
'''Overrides:''' {{tl|ToggleHUD|HUD}}
  
−
Misc / Utility functions
+
Toggles the entire HUD on/off.
  
 
===Native functions===
 
===Native functions===
Line 123: Line 114:
 
{{code|native function '''DisplayWeaponBar''' ()}}
 
{{code|native function '''DisplayWeaponBar''' ()}}
  
−
<!-- enter function description -->
+
Draws the weapon bar.
 +
 
 +
There doesn't seem to be any easy way to customize the behavior of this function. It's not declared as ''final'', so [[creating a custom weapon bar in UT3]] is possible by overriding it and completely reimplementing its functionality in [[UnrealScript]].
  
 
====DrawActorOverlays====
 
====DrawActorOverlays====
Line 147: Line 140:
 
'''Overrides:''' {{tl|PostBeginPlay|HUD}}
 
'''Overrides:''' {{tl|PostBeginPlay|HUD}}
  
−
Create a list of actors needing post renders for. Also Create the Hud Scene
+
Create a list of actors needing {{tl|PostRenderFor||Actor events}}() calls. (That would be all {{cl|Pawn}}s that are neither {{cl|UTPawn}}s nor {{cl|UTVehicle}}s, all {{cl|UTGameObjective}}s, all {{cl|UTOnslaughtNodeTeleporter}}s, all {{cl|UTDeployableNodeLocker}}s and all {{cl|UTOnslaughtFlag}}s.) Other actors are free to register themselves via the {{tl|AddPostRenderedActor|UTHUD|instance functions}}() function.
  
 
====PostRender====
 
====PostRender====
Line 154: Line 147:
 
'''Overrides:''' {{tl|PostRender|HUD}}
 
'''Overrides:''' {{tl|PostRender|HUD}}
  
−
Perform any value precaching, and set up various safe regions
+
Updates drawing-related HUD properties, then calls {{tl|DrawHUD||UTHUD instance functions}}() unless {{tl|bShowHUD|HUD}} is ''False''.
−
 
+
−
NOTE: NO DRAWING should ever occur in PostRender.  Put all drawing code in DrawHud().
+
  
 
====Timer====
 
====Timer====
Line 163: Line 154:
 
'''Overrides:''' {{tl|Timer|Actor|events}}
 
'''Overrides:''' {{tl|Timer|Actor|events}}
  
−
<!-- enter event description -->
+
Sorts the list of {{cl|PlayerReplicationInfo}}s via {{tl|SortPRIArray|GameReplicationInfo}}().
  
 
===Other instance functions===
 
===Other instance functions===
 
See {{cl|UTHUD instance functions}}.
 
See {{cl|UTHUD instance functions}}.

Revision as of 23:47, 25 July 2009

UT3 Object >> Actor >> HUD >> GameHUD >> UTHUD
Package: 
UTGame
Direct subclasses:
UTTeamHUD, UTBetrayalHUD
This class in other games:
UDK

The HUD class for Deathmatch and the base for all UT3 gametype HUDs.

Properties

See UTHUD properties.

Structs

DamageInfo

Modifiers: native

Holds data for directional damage indicators.

float FadeTime 
Time for fade-out.
float FadeValue 
Current fade value.
MaterialInstanceConstant MatConstant 
The MIC for this indicator.

Functions

Static native functions

TranslateBindToFont

native static function TranslateBindToFont (string InBindStr, out Font DrawFont, out string OutBindStr)

Convert a string with potential escape sequenced data in it to a font and the string that should be displayed

Other static functions

DrawBackground

static simulated function DrawBackground (float X, float Y, float Width, float Height, Object.LinearColor DrawColor, Canvas DrawCanvas)

Draws the background of player, vehicle and objective beacons.

DrawBarGraph

static simulated function DrawBarGraph (float X, float Y, float Width, float MaxWidth, float Height, Canvas DrawCanvas, Object.Color BarColor, Object.Color BackColor)

Draws a horizontal bar graph, e.g. for player health.

DrawHealth

static simulated function DrawHealth (float X, float Y, float Width, float MaxWidth, float Height, Canvas DrawCanvas, optional byte Alpha)

Wrapper function for DrawBarGraph() specifically for health-like graphs.

FormatTime

static function string FormatTime (int Seconds)

Converts the number of seconds into a time string of the form HH:MM:SS.

GetFontSizeIndex

static function Font GetFontSizeIndex (int FontSize)

Overrides: HUD.GetFontSizeIndex

Returns a font from the default HudFonts array. Valid font sizes range from 0 to 3, values outside the range are clamped to the nearest valid value.

GetTeamColor

static simulated function GetTeamColor (int TeamIndex, optional out Object.LinearColor ImageColor, optional out Object.Color TextColor)

Returns image color red for team 0, blue for team 1 and white for any other team index. Always returns "light gold" (a pale yellow) as the text color.

Exec functions

GrowHUD

exec function GrowHUD ()

Adds missing elements to HUD.

ReleaseShowScores

exec function ReleaseShowScores ()

Hides the scoreboard.

SetShowScores

exec function SetShowScores (bool bNewValue)

Overrides: HUD.SetShowScores

Shows or hides the scoreboard according to the parameter value.

ShowAllAI

exec function ShowAllAI ()

Toggles whether AI information should be drawn for each bot Pawn.

ShowQuickPickMenu

exec function ShowQuickPickMenu (bool bShow)

Shows or hides the Quick Pick Menu according to the parameter value.

ShowSquadRoutes

exec function ShowSquadRoutes ()

Renders all squad routes of the currently spectated bot as persistent lines in the level. Each route gets a random color.

ShrinkHUD

exec function ShrinkHUD ()

Removes elements from HUD.

StartMusic

exec function StartMusic ()

Creates a UTMusicManager for the player, unless there already is a music manager for that player.

ToggleHUD

exec function ToggleHUD ()

Overrides: HUD.ToggleHUD

Toggles the entire HUD on/off.

Native functions

DisplayWeaponBar

native function DisplayWeaponBar ()

Draws the weapon bar.

There doesn't seem to be any easy way to customize the behavior of this function. It's not declared as final, so creating a custom weapon bar in UT3 is possible by overriding it and completely reimplementing its functionality in UnrealScript.

DrawActorOverlays

native function DrawActorOverlays (Object.Vector Viewpoint, Object.Rotator ViewRotation)


DrawGlowText

native function DrawGlowText (string Text, float X, float Y, optional float MaxHeightInPixels, optional float PulseTime, optional bool bRightJustified)

Draw a glowing string

LinkToHudScene

native function LinkToHudScene ()

This function will attempt to auto-link up HudWidgets to their associated transient property here in the hud.

Events

PostBeginPlay

simulated event PostBeginPlay ()

Overrides: HUD.PostBeginPlay

Create a list of actors needing PostRenderFor() calls. (That would be all Pawns that are neither UTPawns nor UTVehicles, all UTGameObjectives, all UTOnslaughtNodeTeleporters, all UTDeployableNodeLockers and all UTOnslaughtFlags.) Other actors are free to register themselves via the UTHUD.AddPostRenderedActor() function.

PostRender

event PostRender ()

Overrides: HUD.PostRender

Updates drawing-related HUD properties, then calls DrawHUD() unless HUD.bShowHUD is False.

Timer

simulated event Timer ()

Overrides: Actor.Timer

Sorts the list of PlayerReplicationInfos via GameReplicationInfo.SortPRIArray().

Other instance functions

See UTHUD instance functions.

Retrieved from "https://wiki.beyondunreal.com/UE3:UTHUD_(UT3)?oldid=34554"