Difference between revisions of "UE3:UTUITabPage ServerBrowser (UT3)"

Revision as of 02:44, 26 July 2008 (edit) (Talk) ← Older edit	Latest revision as of 01:26, 26 July 2008 (edit) (undo) Wormbo (Talk | contribs) m (1 revision)
(No difference)

---

Latest revision as of 01:26, 26 July 2008

Package: 

UTGame

Implemented interfaces: 

UIDataStoreSubscriber

Direct subclasses:

UTUITabPage_FindQuickMatch, UTUITabPage_ServerFavorites, UTUITabPage_ServerHistory

This class in other games:

UDK

This is an auto-generated page and may need human attention. Please remove the {{autogenerated}} tag if the page seems reasonably complete or replace it with the {{expand}} tag if the page is not yet complete.

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

Tab page for a server browser.

Constants[edit]

See UTUITabPage_ServerBrowser constants.

Properties[edit]

AddFavoriteIdx[edit]

Type: int

Modifiers: transient

Indices for the button bar buttons

BackButtonIdx[edit]

Type: int

Modifiers: transient

Indices for the button bar buttons

bGametypeOutdated[edit]

Type: bool

Modifiers: private, transient

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

bSpectate[edit]

Type: bool

Modifiers: private, transient

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

CancelButtonIdx[edit]

Type: int

Modifiers: transient

Indices for the button bar buttons

DetailsButtonIdx[edit]

Type: int

Modifiers: transient

Indices for the button bar buttons

DetailsList[edit]

Type: UIList

Modifiers: transient

Reference to the list of rules for the selected server

GameInterface[edit]

Type: OnlineGameInterface

Modifiers: transient

Cached game interface pointer

GameTypeCombo[edit]

Type: UTUIComboBox

Modifiers: transient

Reference to the combobox containing the gametypes

JoinButtonIdx[edit]

Type: int

Modifiers: transient

Indices for the button bar buttons

MenuItemDataStore[edit]

Type: UTUIDataStore_MenuItems

Modifiers: transient

Reference to the menu item datastore.

MutatorList[edit]

Type: UIList

Modifiers: transient

reference to the list of mutators for the selected server

OnlineSub[edit]

Type: OnlineSubsystem

Modifiers: transient

Cached online subsystem pointer

PlayerList[edit]

Type: UIList

Modifiers: transient

reference to the list of players for the selected server

PlayerMutDetailsIdx[edit]

Type: int

Modifiers: transient

Indices for the button bar buttons

QueryCompletionAction[edit]

Type: EQueryCompletionAction

Modifiers: private, transient

Different actions to take when a query completes.

RefreshButtonIdx[edit]

Type: int

Modifiers: transient

Indices for the button bar buttons

RefreshingLabel[edit]

Type: UIObject

Modifiers: transient

Reference to a label to display when refreshing.

SearchDataStore[edit]

Type: UTDataStore_GameSearchBase

Modifiers: transient

Reference to the search datastore.

SearchDSName[edit]

Type: name

Modifiers: protected, transient, const

ServerBrowserToolTip[edit]

Type: UIToolTip

Modifiers: private, transient

Tooltip which displays the legend for the SB icons

ServerCountLabel[edit]

Type: UILabel

Modifiers: transient

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

ServerList[edit]

Type: UIList

Modifiers: transient

Reference to the list of servers

ServerPassword[edit]

Type: string

Modifiers: private, transient

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

SpectateButtonIdx[edit]

Type: int

Modifiers: transient

Indices for the button bar buttons

StringListDataStore[edit]

Type: UTUIDataStore_StringList

Modifiers: transient

Reference to the string list datastore.

Subobjects[edit]

WidgetEventComponent[edit]

Class: Engine.UIComp_Event

Inherits from: UTTabPage.WidgetEventComponent

No new values.

Enums[edit]

EQueryCompletionAction[edit]

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[edit]

OnAddToFavorite[edit]

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

OnBack[edit]

Go back delegate for this page.

OnPrepareToSubmitQuery[edit]

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[edit]

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

Functions[edit]

Events[edit]

ActivatePage[edit]

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[edit]

Overrides: UIScreenObject.PostInitialize

PostInitialize event - Sets delegates for the page.

Other instance functions[edit]

See UTUITabPage_ServerBrowser instance functions.