UE3:UTUITabPage_ServerFilter (UDK)

Object >> UIRoot >> UIScreenObject >> UIObject >> UIContainer >> UITabPage >> UTTabPage >> UTUITabPage_Options >> UTUITabPage_ServerFilter

Package: 

UTGame

Implemented interfaces: 

UIDataStoreSubscriber

This class in other games:

UT3

Tab page for a set of options to filter join game server results by.

Properties

bOptionsDirty

Type: bool

Modifiers: private, transient

Indicates that the list of options are out of date and need to be regenerated

MenuDataStore

Type: UTUIDataStore_MenuItems

Reference to the menu items datastore.

SearchDataStore

Type: UTDataStore_GameSearchDM

Reference to the game search datastore.

Subobjects

WidgetEventComponent

Class: Engine.UIComp_Event

Inherits from: UTUITabPage_Options.WidgetEventComponent

No new values.

Delegates

OnSwitchedGameType

delegate transient OnSwitchedGameType ()

Called when the user changes the game type

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: UTUITabPage_Options.PostInitialize

Post initialization event - Setup widget delegates.

Other instance functions

ForceLANOption

final function ForceLANOption (int PlayerIndex)

MarkOptionsDirty

function MarkOptionsDirty ()

Marks the options list as out of date and if visible, refreshes the options list. Called when the user changes the gametype.

OnOptionList_OptionChanged

function OnOptionList_OptionChanged (UIScreenObject InObject, name OptionName, int PlayerIndex)

Overrides: UTUITabPage_Options.OnOptionList_OptionChanged

Pass through the option callback.

ValidateServerType

function ValidateServerType (bool bIsCampaignMode)

Enables / disables the "match type" control based on whether we are signed in online.

Parameters:

• bIsCampaignMode - TRUE if the join game scene was entered through the campaign's "Join Campaign" option