Mostly Harmless

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

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
(Talk)
m (moved properties to own page)
 
Line 9: Line 9:
 
}}
 
}}
 
{{autogenerated}}
 
{{autogenerated}}
Copyright 1998-2007 Epic Games, Inc. All Rights Reserved.
+
Copyright 1998-2008 Epic Games, Inc. All Rights Reserved.
  
 
==Properties==
 
==Properties==
===Property group 'Test'===
+
See {{cl|UTScoreboardPanel properties}}.
====bShowTextBounds====
+
'''Type:''' [[bool]]
+
 
+
'''[[Variables#Modifiers|Modifiers]]:''' transient
+
 
+
<!-- enter variable description -->
+
 
+
====EditorTestNoPlayers====
+
'''Type:''' [[int]]
+
 
+
'''[[Variables#Modifiers|Modifiers]]:''' transient
+
 
+
<!-- enter variable description -->
+
 
+
===Property group 'UTScoreboardPanel'===
+
====AssociatedTeamIndex====
+
'''Type:''' [[int]]
+
 
+
<!-- enter variable description -->
+
 
+
'''Default value:''' -1
+
 
+
====BackgroundCoords====
+
'''Type:''' {{tl|TextureCoordinates|UIRoot|structs}}
+
 
+
<!-- enter variable description -->
+
 
+
====BackgroundTex====
+
'''Type:''' {{cl|Texture2D}}
+
 
+
<!-- enter variable description -->
+
 
+
====BarPerc====
+
'''Type:''' [[float]]
+
 
+
<!-- enter variable description -->
+
 
+
'''Default value:''' 1.2
+
 
+
====bDrawPlayerNum====
+
'''Type:''' [[bool]]
+
 
+
<!-- enter variable description -->
+
 
+
'''Default value:''' True
+
 
+
====bInteractive====
+
'''Type:''' [[bool]]
+
 
+
If true, this scoreboard will be considered to be interactive
+
 
+
====BlingCoords====
+
'''Type:''' {{tl|TextureCoordinates|UIRoot|structs}}
+
 
+
<!-- enter variable description -->
+
 
+
====BlingPct====
+
'''Type:''' {{tl|TextureCoordinates|UIRoot|structs}}
+
 
+
<!-- enter variable description -->
+
 
+
====BlingTex====
+
'''Type:''' {{cl|Texture2D}}
+
 
+
<!-- enter variable description -->
+
 
+
====ClanMultiplier====
+
'''Type:''' [[float]]
+
 
+
<!-- enter variable description -->
+
 
+
====ClanPosAdjust====
+
'''Type:''' [[float]]
+
 
+
<!-- enter variable description -->
+
 
+
====ClanTagPerc====
+
'''Type:''' [[float]]
+
 
+
<!-- enter variable description -->
+
 
+
'''Default value:''' 0.7
+
 
+
====Fonts====
+
'''Type:''' {{tl|SBFontData}}
+
 
+
'''[[Static arrays|Array size]]:''' 4
+
 
+
Font Data 0 = Tiny, 1=Small, 2=Med, 3=Large
+
 
+
'''Default value, index 0:'''
+
{| class="list defaults"
+
! {{tl|SBFontData|||Member}}
+
! Value
+
|-
+
| Font
+
| {{cl|Font}}'EngineFonts.SmallFont'
+
|}
+
 
+
'''Default value, index 1:'''
+
{| class="list defaults"
+
! {{tl|SBFontData|||Member}}
+
! Value
+
|-
+
| Font
+
| {{cl|MultiFont}}'UI_Fonts_Final.HUD.MF_Small'
+
|}
+
 
+
'''Default value, index 2:'''
+
{| class="list defaults"
+
! {{tl|SBFontData|||Member}}
+
! Value
+
|-
+
| Font
+
| {{cl|MultiFont}}'UI_Fonts_Final.HUD.MF_Medium'
+
|}
+
 
+
'''Default value, index 3:'''
+
{| class="list defaults"
+
! {{tl|SBFontData|||Member}}
+
! Value
+
|-
+
| Font
+
| {{cl|MultiFont}}'UI_Fonts_Final.HUD.MF_Large'
+
|}
+
 
+
====FragsXPct====
+
'''Type:''' [[float]]
+
 
+
<!-- enter variable description -->
+
 
+
====HeaderFont====
+
'''Type:''' {{cl|Font}}
+
 
+
<!-- enter variable description -->
+
 
+
====HeaderXPct====
+
'''Type:''' [[float]]
+
 
+
<!-- enter variable description -->
+
 
+
====HeaderYPos====
+
'''Type:''' [[float]]
+
 
+
<!-- enter variable description -->
+
 
+
====HighlightPad====
+
'''Type:''' [[float]]
+
 
+
<!-- enter variable description -->
+
 
+
====LeftMiscStr====
+
'''Type:''' [[string]]
+
 
+
'''[[Variables#Modifiers|Modifiers]]:''' config
+
 
+
<!-- enter variable description -->
+
 
+
====MainPerc====
+
'''Type:''' [[float]]
+
 
+
<!-- enter variable description -->
+
 
+
'''Default value:''' 0.95
+
 
+
====MinFontScale====
+
'''Type:''' [[float]]
+
 
+
<!-- enter variable description -->
+
 
+
====MiscMultiplier====
+
'''Type:''' [[float]]
+
 
+
<!-- enter variable description -->
+
 
+
====MiscPerc====
+
'''Type:''' [[float]]
+
 
+
<!-- enter variable description -->
+
 
+
'''Default value:''' 1.1
+
 
+
====MiscPosAdjust====
+
'''Type:''' [[float]]
+
 
+
<!-- enter variable description -->
+
 
+
====PlayerNamePad====
+
'''Type:''' [[float]]
+
 
+
<!-- enter variable description -->
+
 
+
====RightMiscStr====
+
'''Type:''' [[string]]
+
 
+
'''[[Variables#Modifiers|Modifiers]]:''' config
+
 
+
<!-- enter variable description -->
+
 
+
====ScoreFont====
+
'''Type:''' {{cl|Font}}
+
 
+
<!-- enter variable description -->
+
 
+
====ScorePosition====
+
'''Type:''' {{tl|Vector2D|Object|structs}}
+
 
+
<!-- enter variable description -->
+
 
+
====SelBarTex====
+
'''Type:''' {{cl|Texture2D}}
+
 
+
<!-- enter variable description -->
+
 
+
'''Default value:''' {{cl|Texture2D}}'UI_HUD.HUD.UI_HUD_BaseC'
+
 
+
====SpacerPerc====
+
'''Type:''' [[float]]
+
 
+
<!-- enter variable description -->
+
 
+
====TextLeftPadPct====
+
'''Type:''' [[float]]
+
 
+
<!-- enter variable description -->
+
 
+
====TextPctHeight====
+
'''Type:''' [[float]]
+
 
+
<!-- enter variable description -->
+
 
+
====TextPctWidth====
+
'''Type:''' [[float]]
+
 
+
<!-- enter variable description -->
+
 
+
====TextTopPadPct====
+
'''Type:''' [[float]]
+
 
+
<!-- enter variable description -->
+
 
+
===Internal variables===
+
====bCensor====
+
'''Type:''' [[bool]]
+
 
+
'''[[Variables#Modifiers|Modifiers]]:''' transient
+
 
+
<!-- enter variable description -->
+
 
+
====bMustDrawLocalPRI====
+
'''Type:''' [[bool]]
+
 
+
whether or not this list should always attempt to include the local player's PRI, skipping other players if necessary to make it fit
+
 
+
'''Default value:''' True
+
 
+
====FakeNames====
+
'''Type:''' [[string]]
+
 
+
'''[[Static arrays|Array size]]:''' 32
+
 
+
'''[[Variables#Modifiers|Modifiers]]:''' transient
+
 
+
<!-- enter variable description -->
+
 
+
====HeaderTitle_Deaths====
+
'''Type:''' [[string]]
+
 
+
<!-- enter variable description -->
+
 
+
====HeaderTitle_Name====
+
'''Type:''' [[string]]
+
 
+
<!-- enter variable description -->
+
 
+
====HeaderTitle_Score====
+
'''Type:''' [[string]]
+
 
+
<!-- enter variable description -->
+
 
+
====LastCellHeight====
+
'''Type:''' [[float]]
+
 
+
'''[[Variables#Modifiers|Modifiers]]:''' transient
+
 
+
We cache this so we don't have to resize everything for a mouse click
+
 
+
====LeftColumnPosX====
+
'''Type:''' [[float]]
+
 
+
'''[[Variables#Modifiers|Modifiers]]:''' transient
+
 
+
<!-- enter variable description -->
+
 
+
====LeftColumnWidth====
+
'''Type:''' [[float]]
+
 
+
'''[[Variables#Modifiers|Modifiers]]:''' transient
+
 
+
<!-- enter variable description -->
+
 
+
====NameCnt====
+
'''Type:''' [[int]]
+
 
+
'''[[Variables#Modifiers|Modifiers]]:''' transient
+
 
+
<!-- enter variable description -->
+
 
+
====PingString====
+
'''Type:''' [[string]]
+
 
+
'''[[Variables#Modifiers|Modifiers]]:''' localized
+
 
+
<!-- enter variable description -->
+
 
+
'''Default value:''' "Ping"
+
 
+
====PlayerOwner====
+
'''Type:''' {{cl|UTPlayerController}}
+
 
+
'''[[Variables#Modifiers|Modifiers]]:''' transient
+
 
+
<!-- enter variable description -->
+
 
+
====PRIList====
+
'''Type:''' [[array]]<{{cl|UTPlayerReplicationInfo}}>
+
 
+
'''[[Variables#Modifiers|Modifiers]]:''' transient
+
 
+
Holds a list of PRI's currently being worked on.  Note it cleared every frame
+
 
+
====RightColumnPosX====
+
'''Type:''' [[float]]
+
 
+
'''[[Variables#Modifiers|Modifiers]]:''' transient
+
 
+
<!-- enter variable description -->
+
 
+
====RightColumnWidth====
+
'''Type:''' [[float]]
+
 
+
'''[[Variables#Modifiers|Modifiers]]:''' transient
+
 
+
<!-- enter variable description -->
+
 
+
====SelectedPI====
+
'''Type:''' [[int]]
+
 
+
'''[[Variables#Modifiers|Modifiers]]:''' transient
+
 
+
The Player Index of the currently selected player
+
 
+
====TeamColors====
+
'''Type:''' {{tl|Color|Object|structs}}
+
 
+
'''[[Static arrays|Array size]]:''' 2
+
 
+
'''[[Variables#Modifiers|Modifiers]]:''' transient
+
 
+
<!-- enter variable description -->
+
 
+
====UTHudSceneOwner====
+
'''Type:''' {{cl|UTUIScene_Hud}}
+
 
+
Cached reference to the HUDSceneOwner
+
 
+
===Default values===
+
{| class="list defaults"
+
! Property
+
! Value
+
|-
+
| {{tl|DefaultStates||UIScreenObject}}[3]
+
| [[Types#Class|Class]]'{{cl|UIState_Active|Engine}}'
+
|-
+
| {{tl|DefaultStates||UIScreenObject}}[4]
+
| [[Types#Class|Class]]'{{cl|UIState_Focused|Engine}}'
+
|}
+
 
+
===Subobjects===
+
====WidgetEventComponent====
+
'''Class:''' {{cl|UIComp_Event|Engine}}
+
 
+
'''Inherits from:''' {{tl|WidgetEventComponent|UTDrawPanel}}
+
 
+
''No new values.''
+
  
 
==Enums==
 
==Enums==

Latest revision as of 05:36, 16 August 2009

UT3 Object >> UIRoot >> UIScreenObject >> UIObject >> UTUI_Widget >> UTDrawPanel >> UTScoreboardPanel
Package: 
UTGame
Direct subclasses:
UTDuelQueueScoreboardPanel, UTTDMScoreboardPanel
This class in other games:
UDK

Copyright 1998-2008 Epic Games, Inc. All Rights Reserved.

Properties[edit]

See UTScoreboardPanel properties.

Enums[edit]

EFontType[edit]

Defines the different font sizes

EFT_Tiny 
EFT_Small 
EFT_Med 
EFT_Large 

Structs[edit]

SBFontData[edit]

Holds the font data. We cache the max char height for quick lookup

Font Font 
int CharHeight 

Delegates[edit]

OnSelectionChange[edit]

delegate OnSelectionChange (UTScoreboardPanel TargetScoreboard, UTPlayerReplicationInfo PRI)


Functions[edit]

Events[edit]

DrawPanel[edit]

event DrawPanel ()

Overrides: UTDrawPanel.DrawPanel

Draw the Scoreboard

GetSupportedUIActionKeyNames[edit]

event GetSupportedUIActionKeyNames (out array<nameout_KeyNames)

Overrides: UIScreenObject.GetSupportedUIActionKeyNames

Setup Input subscriptions

PostInitialize[edit]

event PostInitialize ()

Overrides: UIScreenObject.PostInitialize

Called after this screen object's children have been initialized

Other instance functions[edit]

See UTScoreboardPanel instance functions.