UE3:UTUITabPage_ServerFavorites (UT3)

From Unreal Wiki, The Unreal Engine Documentation Site

Package:: UTGame
Implemented interfaces:: UIDataStoreSubscriber

This class is a specialized server browser which displays only those servers which the player has marked as a favorite. This server browser does not respect filter options.

[edit] Properties

[edit] AddIPIdx

Type: int

Modifiers: transient

[edit] QueryHelper

Type: UTQueryHelper

Reference to the query helper object, which performs the query for retrieving server details from an IP

[edit] RemoveFavoriteIdx

Type: int

Modifiers: transient

[edit] Subobjects

[edit] WidgetEventComponent

Class: Engine.UIComp_Event

Inherits from: UTUITabPage_ServerBrowser.WidgetEventComponent

No new values.

[edit] Functions

[edit] Events

[edit] PostInitialize

event PostInitialize ()

Overrides: UTUITabPage_ServerBrowser.PostInitialize

Sets the correct tab button caption.

[edit] Other instance functions

[edit] AdjustLayout

function AdjustLayout ()

Overrides: UTUITabPage_ServerBrowser.AdjustLayout

Adjusts the layout of the scene based on the current platform

[edit] FindServerByIPComplete

function FindServerByIPComplete (OnlineGameSearch.OnlineGameSearchResult Result)

[edit] GetDesiredMatchType

function int GetDesiredMatchType ()

Overrides: UTUITabPage_ServerBrowser.GetDesiredMatchType

Determines which type of matches the user wishes to search for (i.e. LAN, unranked, ranked, etc.)

[edit] GetFavoritesDataStore

function UTDataStore_GameSearchFavorites GetFavoritesDataStore ()

Overrides: UTUITabPage_ServerBrowser.GetFavoritesDataStore

Wrapper for getting a reference to the favorites data store.

[edit] OnAddIPDialog_Closed

function OnAddIPDialog_Closed (UTUIScene_MessageBox MessageBox, int SelectedOption, int PlayerIndex)

[edit] OnButtonBar_AddIP

function bool OnButtonBar_AddIP (UIScreenObject InButton, int InPlayerIndex)

ButtonBar - Add IP to favourites

[edit] OnButtonBar_RemoveFavorite

function bool OnButtonBar_RemoveFavorite (UIScreenObject InButton, int InPlayerIndex)

ButtonBar - Remove from favorite

[edit] RemoveFavorite

function RemoveFavorite (int inPlayerIndex)

Removes the currently selected server from the list of favorites

[edit] SetupExtraButtons

function SetupExtraButtons (UTUIButtonBar ButtonBar)

Overrides: UTUITabPage_ServerBrowser.SetupExtraButtons

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

[edit] UpdateButtonStates

function UpdateButtonStates ()

Overrides: UTUITabPage_ServerBrowser.UpdateButtonStates

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