UE3:UTUITabPage_ServerBrowser instance functions (UT3)

Object >> UIRoot >> UIScreenObject >> UIObject >> UIContainer >> UITabPage >> UTTabPage >> UTUITabPage_ServerBrowser (instance functions)

UTUITabPage_ServerBrowser instance functions in other games:

UDK

Other member categories for this class:

UTUITabPage ServerBrowser constants

Instance functions

AddToFavorites

function AddToFavorites (int inPlayerIndex)

Adds the selected server to the list of favorites

AdjustLayout

function AdjustLayout ()

Adjusts the layout of the scene based on the current platform

AllowCloseScene

function bool AllowCloseScene ()

Determine if we're in the right state to close the "Join Game" scene (cancels any pending queries, etc.)

Returns:

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

function bool AllowJoinServer ()

Determine if we're in the right state to join a server (cancels any pending queries, etc.)

Returns:

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

function string BuildJoinURL (string ResolvedConnectionURL)

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

Parameters:

• ResolvedConnectionURL - the platform specific URL information

Returns:

the final URL to use to open the map

CancelQuery

function CancelQuery (optional EQueryCompletionAction DesiredCancelAction)

Fires an asynchronous task to cancels all active queries.

Parameters:

• DesiredCancelAction - specifies what should happen when the asynchronous task completes.

CheckToolTipPosition

function bool CheckToolTipPosition (UIToolTip Sender)

Handler for the tooltip's CanShowToolTip delegate. Prevents the tooltip timer from being activated if the cursor is not over the correct [first] column.

Parameters:

• ToolTip - the tooltip, duh

Returns:

TRUE to allow the tooltip to be made visible; FALSE to keep it hidden.

Cleanup

function Cleanup ()

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

function ConditionalRefreshServerList (int PlayerIndex)

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

GetButtonBarButton

final function UTUIButtonBarButton GetButtonBarButton (int ButtonIndex)

Wrapper for grabbing a reference to a button bar button.

GetDesiredMatchType

function int GetDesiredMatchType ()

GetFavoritesDataStore

function UTDataStore_GameSearchFavorites GetFavoritesDataStore ()

Wrapper for getting a reference to the favorites data store. Stub for child classes.

GetGameTypeSearchProviderIndex

function int GetGameTypeSearchProviderIndex (optional string GameClassName)

Retrieve the index in the game search data store's list of search results for the specified gametype class

Parameters:

• GameClassName - the path name of the gametype to find; if not specified, uses the currently selected gametype

Returns:

the index into the UIDataStore_OnlineGameSearch's GameSearchCfgList array for the gametype specified.

HandleInputKey

function bool HandleInputKey (const out UIRoot.InputEventParameters EventParms)

Overrides: UTTabPage.HandleInputKey

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.

Parameters:

• EventParms - information about the input event.

Returns:

TRUE to indicate that this input key was processed; no further processing will occur on this input key event.

HasSelectedServerInFavorites

function bool HasSelectedServerInFavorites (int ControllerId)

Wrapper for HasServerInFavorites which encapsulates finding the UniqueNetId for the currently selected server.

Parameters:

• ControllerId - the index of the controller associated with the logged in player.

Returns:

TRUE if the currently selected server is in the list of server favorites.

HasServerInFavorites

function bool HasServerInFavorites (int ControllerId, const out OnlineSubsystem.UniqueNetId IdToFind)

Determines whether the server with the specified Id is in the list of favorites.

Parameters:

• ControllerId - the index of the controller associated with the logged in player.
• IdToFind - the UniqueNetId for the server to find

Returns:

TRUE if the specified server is in the list of server favorites.

JoinServer

function JoinServer ()

Joins the currently selected server.

MessageBoxClosed

function MessageBoxClosed ()

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

function NotifyGameTypeChanged ()

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

OnButtonBar_AddFavorite

function bool OnButtonBar_AddFavorite (UIScreenObject InButton, int InPlayerIndex)

ButtonBar - Add to favorite

OnButtonBar_Back

function bool OnButtonBar_Back (UIScreenObject InButton, int InPlayerIndex)

ButtonBar - Back

OnButtonBar_CancelQuery

function bool OnButtonBar_CancelQuery (UIScreenObject InButton, int inPlayerIndex)

OnButtonBar_JoinServer

function bool OnButtonBar_JoinServer (UIScreenObject InButton, int InPlayerIndex)

ButtonBar - JoinServer

OnButtonBar_MutatorDetails

function bool OnButtonBar_MutatorDetails (UIScreenObject InButton, int InPlayerIndex)

OnButtonBar_PlayerDetails

function bool OnButtonBar_PlayerDetails (UIScreenObject InButton, int InPlayerIndex)

OnButtonBar_Refresh

function bool OnButtonBar_Refresh (UIScreenObject InButton, int InPlayerIndex)

ButtonBar - Refresh

OnButtonBar_ServerDetails

function bool OnButtonBar_ServerDetails (UIScreenObject InButton, int InPlayerIndex)

ButtonBar - ServerDetails (console only)

OnButtonBar_SpectateServer

function bool OnButtonBar_SpectateServer (UIScreenObject InButton, int InPlayerIndex)

OnCancelSearchComplete

function OnCancelSearchComplete (bool bWasSuccessful)

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

OnFindOnlineGamesComplete

function OnFindOnlineGamesComplete (bool bWasSuccessful)

Delegate fired when the search for an online game has completed

Parameters:

• bWasSuccessful - true if the async action completed without error, false if there was an error

OnFindOnlineGamesCompleteDelegate

function OnFindOnlineGamesCompleteDelegate (bool bWasSuccessful)

Delegate fired each time a new server is recieved, or when the action completes (if there was an error)

Parameters:

• bWasSuccessful - true if the async action completed without error, false if there was an error

OnGameTypeChanged

function OnGameTypeChanged (UIObject Sender, int PlayerIndex)

Called when the user changes the currently selected gametype via the gametype combo.

Parameters:

• Sender - the UIObject whose value changed
• 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

function OnJoinGameComplete (bool bSuccessful)

Callback for when the join completes.

OnPasswordDialog_Closed

private final function OnPasswordDialog_Closed (UTUIScene_MessageBox MessageBox, int SelectedOption, int PlayerIndex)

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

OnServerList_SubmitSelection

function OnServerList_SubmitSelection (UIList Sender, int PlayerIndex)

Server List - Submit Selection.

OnServerList_ValueChanged

function OnServerList_ValueChanged (UIObject Sender, int PlayerIndex)

Server List - Value Changed.

ProcessJoin

private function ProcessJoin ()

PromptForServerPassword

private final function PromptForServerPassword ()

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

QueryServerBrowserTooltip

function bool QueryServerBrowserTooltip (UIObject Sender, out UIToolTip CustomToolTip)

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.

Parameters:

• Sender - the widget that will be displaying the tooltip
• 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.

Returns:

return FALSE to prevent any tool-tips from being shown, including parents.

RefreshDetailsList

function RefreshDetailsList ()

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

RefreshServerList

function RefreshServerList (int InPlayerIndex, optional int MaxResults)

Refreshes the server list.

ServerIsPrivate

function bool ServerIsPrivate ()

Determines if the currently selected server is password protected.

Returns:

TRUE if a valid server is selected and it is password protected; FALSE otherwise.

ServerListResorted

function ServerListResorted (UIList Sender)

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

SetupButtonBar

function SetupButtonBar (UTUIButtonBar ButtonBar)

Overrides: UTTabPage.SetupButtonBar

Sets buttons for the scene.

SetupExtraButtons

function SetupExtraButtons (UTUIButtonBar ButtonBar)

Provides an easy way for child classes to add additional buttons before the ButtonBar's button states are updated

ShowServerDetails

function ShowServerDetails ()

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

SubmitServerListQuery

function SubmitServerListQuery (int PlayerIndex)

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

UpdateButtonStates

function UpdateButtonStates ()

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

UpdateServerCount

function UpdateServerCount ()

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