UTGame.UTUITabPage_ServerBrowser

Extends

UTTabPage

Modifiers

placeable

Copyright 1998-2007 Epic Games, Inc. All Rights Reserved. Tab page for a server browser.

Core.Object
|   
+-- Engine.UIRoot
   |   
   +-- Engine.UIScreenObject
      |   
      +-- Engine.UIObject
         |   
         +-- Engine.UIContainer
            |   
            +-- Engine.UITabPage
               |   
               +-- UTGame.UTTabPage
                  |   
                  +-- UTGame.UTUITabPage_ServerBrowser

Direct Known Subclasses:

UTUITabPage_FindQuickMatch, UTUITabPage_ServerHistory

Delegates Summary
	transient	OnBack ()
	transient	OnPrepareToSubmitQuery (UTUITabPage_ServerBrowser Sender)
	transient	OnSwitchedGameType ()

Functions Summary
	bool	ActivatePage (int PlayerIndex, bool bActivate, optional bool bTakeFocus=true ))
		AdjustLayout ()))
	bool	AllowCloseScene ()))
	bool	AllowJoinServer ()))
	string	BuildJoinURL (string ResolvedConnectionURL))
		CancelQuery (optional EQueryCompletionAction DesiredCancelAction=QUERYACTION_Default ))
	bool	CheckToolTipPosition (UIToolTip Sender ))
		Cleanup ()))
		ConditionalRefreshServerList (int PlayerIndex ))
	UTUIButtonBarButton	GetButtonBarButton (int ButtonIndex ))
	int	GetDesiredMatchType ()))
	int	GetGameTypeSearchProviderIndex (optional string GameClassName ))
	bool	HandleInputKey (const out InputEventParameters EventParms ))
		JoinServer ()))
		MessageBoxClosed ()))
		NotifyGameTypeChanged ()))
	bool	OnButtonBar_Back (UIScreenObject InButton, int InPlayerIndex))
	bool	OnButtonBar_CancelQuery (UIScreenObject InButton, int inPlayerIndex ))
	bool	OnButtonBar_JoinServer (UIScreenObject InButton, int InPlayerIndex))
	bool	OnButtonBar_Refresh (UIScreenObject InButton, int InPlayerIndex))
	bool	OnButtonBar_ServerDetails (UIScreenObject InButton, int InPlayerIndex ))
	bool	OnButtonBar_SpectateServer (UIScreenObject InButton, int InPlayerIndex))
		OnCancelSearchComplete (bool bWasSuccessful ))
		OnFindOnlineGamesComplete (bool bWasSuccessful))
		OnFindOnlineGamesCompleteDelegate (bool bWasSuccessful))
		OnGameTypeChanged (UIObject Sender, int PlayerIndex ))
		OnJoinGameComplete (bool bSuccessful))
		OnPasswordDialog_Closed (UTUIScene_MessageBox MessageBox, int SelectedOption, int PlayerIndex))
		OnServerList_SubmitSelection (UIList Sender, int PlayerIndex ))
		OnServerList_ValueChanged (UIObject Sender, int PlayerIndex ))
		PostInitialize ()))
		ProcessJoin ()))
		PromptForServerPassword ()))
	bool	QueryServerBrowserTooltip (UIObject Sender, out UIToolTip CustomToolTip ))
		RefreshDetailsList ()))
		RefreshServerList (int InPlayerIndex, optional int MaxResults=1000))
	bool	ServerIsPrivate ()))
		ServerListResorted (UIList Sender ))
		SetupButtonBar (UTUIButtonBar ButtonBar))
		ShowServerDetails ()))
		SubmitServerListQuery (int PlayerIndex ))
		UpdateButtonStates ()))
		UpdateServerCount ()))

SERVERBROWSER_SERVERTYPE_LAN Source code

SERVERBROWSER_SERVERTYPE_RANKED Source code

SERVERBROWSER_SERVERTYPE_UNRANKED Source code

BackButtonIdx Source code

Indices for the button bar buttons

bGametypeOutdated Source code

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

bSpectate Source code

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

CancelButtonIdx Source code

Indices for the button bar buttons

DetailsButtonIdx Source code

Indices for the button bar buttons

DetailsList Source code

Reference to the list of rules for the selected server

GameInterface Source code

Cached game interface pointer

GameTypeCombo Source code

Reference to the combobox containing the gametypes

JoinButtonIdx Source code

Indices for the button bar buttons

MenuItemDataStore Source code

Reference to the menu item datastore.

MutatorList Source code

reference to the list of mutators for the selected server

OnlineSub Source code

Cached online subsystem pointer

QueryCompletionAction Source code

Different actions to take when a query completes.

RefreshButtonIdx Source code

Indices for the button bar buttons

RefreshingLabel Source code

Reference to a label to display when refreshing.

SearchDataStore Source code

Reference to the search datastore.

SearchDSName Source code

ServerBrowserToolTip Source code

Tooltip which displays the legend for the SB icons

ServerCountLabel Source code

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

ServerList Source code

Reference to the list of servers

ServerPassword Source code

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

SpectateButtonIdx Source code

Indices for the button bar buttons

StringListDataStore Source code

Reference to the string list datastore.

EQueryCompletionAction Source code

OnBack Source code

Go back delegate for this page.

OnPrepareToSubmitQuery Source code

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 Source code

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

ActivatePage Source code

Causes this page to become (or no longer be) the tab control's currently active page.
@param PlayerIndex the index [into the Engine.GamePlayers array] for the player that wishes to activate this page.
@param bActivate TRUE if this page should become the tab control's active page; FALSE if it is losing the active status.
@param bTakeFocus specify TRUE to give this panel focus once it's active (only relevant if bActivate = true)
@return TRUE if this page successfully changed its active state; FALSE otherwise.

AdjustLayout Source code

Adjusts the layout of the scene based on the current platform

AllowCloseScene Source code

Determine if we're in the right state to close the "Join Game" scene (cancels any pending queries, etc.)
@return TRUE if closing the scene should be allowed; FALSE if there a query is still active - will close the scene when it's safe to do so.

AllowJoinServer Source code

Determine if we're in the right state to join a server (cancels any pending queries, etc.)
@return TRUE if joining a server should be allowed; FALSE if there a query is still active - will join the server when it's safe to do so.

BuildJoinURL Source code

Builds the string needed to join a game from the resolved connection: "open 172.168.0.1" NOTE: Overload this method to modify the URL before exec-ing it
@param ResolvedConnectionURL the platform specific URL information
@return the final URL to use to open the map

CancelQuery Source code

Fires an asynchronous task to cancels all active queries.
@param DesiredCancelAction specifies what should happen when the asynchronous task completes.

CheckToolTipPosition Source code

Handler for the tooltip's CanShowToolTip delegate. Prevents the tooltip timer from being activated if the cursor is not over the correct [first] column.
@param ToolTip the tooltip, duh
@return TRUE to allow the tooltip to be made visible; FALSE to keep it hidden.

Cleanup Source code

Called when the owning scene is being closed - provides a hook for the tab page to ensure it's cleaned up all external references (i.e. delegates, etc.)

ConditionalRefreshServerList Source code

Refreshes the server list by submitting a new query if certain conditions are met.

GetButtonBarButton Source code

Wrapper for grabbing a reference to a button bar button.

GetDesiredMatchType Source code

GetGameTypeSearchProviderIndex Source code

Retrieve the index in the game search data store's list of search results for the specified gametype class
@param GameClassName the path name of the gametype to find; if not specified, uses the currently selected gametype
@return the index into the UIDataStore_OnlineGameSearch's GameSearchCfgList array for the gametype specified.

HandleInputKey Source code

Provides a hook for unrealscript to respond to input using actual input key names (i.e. Left, Tab, etc.) Called when an input key event is received which this widget responds to and is in the correct state to process. The keys and states widgets receive input for is managed through the UI editor's key binding dialog (F8). This delegate is called BEFORE kismet is given a chance to process the input.
@param EventParms information about the input event.
@return TRUE to indicate that this input key was processed; no further processing will occur on this input key event.

JoinServer Source code

Joins the currently selected server.

MessageBoxClosed Source code

Handler for the message box scene's OnClose delegate when we're displaying a modal dialog while waiting for the active query to complete.

NotifyGameTypeChanged Source code

Notification that the currently selected gametype was changed externally. Update this tab page to reflect the new gametype.

OnButtonBar_Back Source code

ButtonBar - Back

OnButtonBar_CancelQuery Source code

OnButtonBar_JoinServer Source code

ButtonBar - JoinServer

OnButtonBar_Refresh Source code

ButtonBar - Refresh

OnButtonBar_ServerDetails Source code

ButtonBar - ServerDetails (console only)

OnButtonBar_SpectateServer Source code

OnCancelSearchComplete Source code

Handler for the 'cancel query' asynchronous task completion. Performs the actions dictated by the current QueryCompletionAction, as set when CancelQuery was called.

OnFindOnlineGamesComplete Source code

Delegate fired when the search for an online game has completed
@param bWasSuccessful true if the async action completed without error, false if there was an error

OnFindOnlineGamesCompleteDelegate Source code

Delegate fired each time a new server is recieved, or when the action completes (if there was an error)
@param bWasSuccessful true if the async action completed without error, false if there was an error

OnGameTypeChanged Source code

Called when the user changes the currently selected gametype via the gametype combo.
@param Sender the UIObject whose value changed
@param PlayerIndex the index of the player that generated the call to this method; used as the PlayerIndex when activating UIEvents; if not specified, the value of GetBestPlayerIndex() is used instead.

OnJoinGameComplete Source code

Callback for when the join completes.

OnPasswordDialog_Closed Source code

The user has made a selection of the choices available to them.

OnServerList_SubmitSelection Source code

Server List - Submit Selection.

OnServerList_ValueChanged Source code

Server List - Value Changed.

PostInitialize Source code

PostInitialize event - Sets delegates for the page.

ProcessJoin Source code

PromptForServerPassword Source code

Displays a dialog to the user which allows him to enter the password for the currently selected server.

QueryServerBrowserTooltip Source code

Called when this widget (or one of its children) becomes the ActiveControl. Provides a way for child classes or containers to easily override or short-circuit the standard tooltip that is normally shown. If this delegate is not assigned to any function, the default tool-tip will be displayed if this widget has a data store binding property named "ToolTipBinding" which is bound to a valid data store.
@param Sender the widget that will be displaying the tooltip
@param CustomToolTip to provide a custom tooltip implementation, fill in in this value and return TRUE. The custom tool tip object will then be activated by native code.
@return return FALSE to prevent any tool-tips from being shown, including parents.

RefreshDetailsList Source code

Refreshes the game details list using the currently selected item in the server list.

RefreshServerList Source code

Refreshes the server list.

ServerIsPrivate Source code

Determines if the currently selected server is password protected.
@return TRUE if a valid server is selected and it is password protected; FALSE otherwise.

ServerListResorted Source code

called when the list is resorted (can be triggered by manual resort from user input or automatic resort from new elements added

SetupButtonBar Source code

Sets buttons for the scene.

ShowServerDetails Source code

Opens a custom UIScene which displays more verbose details about the server currently selected in the server browser. Console only.

SubmitServerListQuery Source code

Submits a query for the list of servers which match the current configuration.

UpdateButtonStates Source code

Updates the enabled state of certain button bar buttons depending on whether a server is selected or not.

UpdateServerCount Source code

Updates the server count label with the number of servers received so far for the currently selected gametype.

defaultproperties
{
   Begin Object Class=UIComp_Event Name=WidgetEventComponent ObjName=WidgetEventComponent Archetype=UIComp_Event'UTGame.Default__UTTabPage:WidgetEventComponent'
      ObjectArchetype=UIComp_Event'UTGame.Default__UTTabPage:WidgetEventComponent'
   End Object
   EventProvider=WidgetEventComponent
   Name="Default__UTUITabPage_ServerBrowser"
   ObjectArchetype=UTTabPage'UTGame.Default__UTTabPage'
}