UE3:UTUITabPage_ServerBrowser (UT3)

Object >> UIRoot >> UIScreenObject >> UIObject >> UIContainer >> UITabPage >> UTTabPage >> UTUITabPage_ServerBrowser

Package: 

UTGame

Implemented interfaces: 

UIDataStoreSubscriber

Direct subclasses:

UTUITabPage_FindQuickMatch, UTUITabPage_ServerFavorites, UTUITabPage_ServerHistory

This class in other games:

UDK

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

Tab page for a server browser.

Constants

See UTUITabPage_ServerBrowser constants.

Properties

AddFavoriteIdx

Type: int

Modifiers: transient

Indices for the button bar buttons

BackButtonIdx

Type: int

Modifiers: transient

Indices for the button bar buttons

bGametypeOutdated

Type: bool

Modifiers: private, transient

Indicates that the current gametype was changed externally - submit a new query when possible

bSpectate

Type: bool

Modifiers: private, transient

Indicates that the current gametype was changed externally - submit a new query when possible

CancelButtonIdx

Type: int

Modifiers: transient

Indices for the button bar buttons

DetailsButtonIdx

Type: int

Modifiers: transient

Indices for the button bar buttons

DetailsList

Type: UIList

Modifiers: transient

Reference to the list of rules for the selected server

GameInterface

Type: OnlineGameInterface

Modifiers: transient

Cached game interface pointer

GameTypeCombo

Type: UTUIComboBox

Modifiers: transient

Reference to the combobox containing the gametypes

JoinButtonIdx

Type: int

Modifiers: transient

Indices for the button bar buttons

MenuItemDataStore

Type: UTUIDataStore_MenuItems

Modifiers: transient

Reference to the menu item datastore.

MutatorList

Type: UIList

Modifiers: transient

reference to the list of mutators for the selected server

OnlineSub

Type: OnlineSubsystem

Modifiers: transient

Cached online subsystem pointer

PlayerList

Type: UIList

Modifiers: transient

reference to the list of players for the selected server

PlayerMutDetailsIdx

Type: int

Modifiers: transient

Indices for the button bar buttons

QueryCompletionAction

Type: EQueryCompletionAction

Modifiers: private, transient

Different actions to take when a query completes.

RefreshButtonIdx

Type: int

Modifiers: transient

Indices for the button bar buttons

RefreshingLabel

Type: UIObject

Modifiers: transient

Reference to a label to display when refreshing.

SearchDataStore

Type: UTDataStore_GameSearchBase

Modifiers: transient

Reference to the search datastore.

SearchDSName

Type: name

Modifiers: protected, transient, const

ServerBrowserToolTip

Type: UIToolTip

Modifiers: private, transient

Tooltip which displays the legend for the SB icons

ServerCountLabel

Type: UILabel

Modifiers: transient

Reference to the label which displays the number of servers currently loaded in the list

ServerList

Type: UIList

Modifiers: transient

Reference to the list of servers

ServerPassword

Type: string

Modifiers: private, transient

stores the password entered by the user when attempting to connect to a server with a password

SpectateButtonIdx

Type: int

Modifiers: transient

Indices for the button bar buttons

StringListDataStore

Type: UTUIDataStore_StringList

Modifiers: transient

Reference to the string list datastore.

Subobjects

WidgetEventComponent

Class: Engine.UIComp_Event

Inherits from: UTTabPage.WidgetEventComponent

No new values.

Enums

EQueryCompletionAction

Different actions to take when a query completes.

QUERYACTION_None 

no query action set

QUERYACTION_Default 

do nothing when the query completes; default behavior

QUERYACTION_CloseScene 

This is set when the user wants to close the scene but we still have active queries. When the queries are completed

(either through being cancelled or receiving all results), close the scene.

QUERYACTION_JoinServer 

This is set when the user has chosen a server from the list. When the queries are completed or cancelled, join the currently selected server.

QUERYACTION_RefreshAll 

This is set when the user switches from LAN to Internet or vice versa. When the queries are completed of cancelled, clear all results and reissue the

current query.

Delegates

OnAddToFavorite

delegate transient OnAddToFavorite ()

called when the user moves a server from the history page to the favorites page

OnBack

delegate transient OnBack ()

Go back delegate for this page.

OnPrepareToSubmitQuery

delegate transient OnPrepareToSubmitQuery (UTUITabPage_ServerBrowser Sender)

Called when we're about the submit a server query. Usual thing to do is make sure the GameSearch object is up to date

OnSwitchedGameType

delegate transient OnSwitchedGameType ()

Called when the user changes the game type using the combo box

Functions

Events

ActivatePage

event bool ActivatePage (int PlayerIndex, bool bActivate, optional bool bTakeFocus)

Overrides: UITabPage.ActivatePage

Causes this page to become (or no longer be) the tab control's currently active page.

Parameters:

• PlayerIndex - the index [into the Engine.GamePlayers array] for the player that wishes to activate this page.
• bActivate - TRUE if this page should become the tab control's active page; FALSE if it is losing the active status.
• bTakeFocus - specify TRUE to give this panel focus once it's active (only relevant if bActivate = true)

Returns:

TRUE if this page successfully changed its active state; FALSE otherwise.

PostInitialize

event PostInitialize ()

Overrides: UIScreenObject.PostInitialize

PostInitialize event - Sets delegates for the page.

Other instance functions

See UTUITabPage_ServerBrowser instance functions.