UE3:UTUIFrontEnd_JoinGame (UT3)

Object >> UIRoot >> UIScreenObject >> UIScene >> UTUIScene >> UTUIFrontEnd >> UTUIFrontEnd_JoinGame

Package: 

UTGame

This class in other games:

UDK

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

Join Game scene for UT3.

Properties

bCampaignMode

Type: bool

Modifiers: transient

true when we're opened via the campaign menu's 'join online game' option

bIssuedInitialFavoritesQuery

Type: bool

Modifiers: transient

Tracks whether a query has been initiated. Set to TRUE once the first query is started - this is how we catch cases where the user clicked on the sb tab directly instead of clicking the Search button.

bIssuedInitialHistoryQuery

Type: bool

Modifiers: transient

Tracks whether a query has been initiated. Set to TRUE once the first query is started - this is how we catch cases where the user clicked on the sb tab directly instead of clicking the Search button.

bIssuedInitialQuery

Type: bool

Modifiers: transient

Tracks whether a query has been initiated. Set to TRUE once the first query is started - this is how we catch cases where the user clicked on the sb tab directly instead of clicking the Search button.

ServerBrowserTab

Type: UTUITabPage_ServerBrowser

Tab page references for this scene.

ServerFavoritesTab

Type: UTUITabPage_ServerFavorites

ServerFilterTab

Type: UTUITabPage_ServerFilter

ServerHistoryTab

Type: UTUITabPage_ServerHistory

Default values

Property	Value
bMenuLevelRestoresScene	True
bRequiresNetwork	True

Subobjects

SceneEventComponent

Class: Engine.UIComp_Event

Inherits from: UTUIFrontEnd.SceneEventComponent

No new values.

Functions

Events

PostInitialize

event PostInitialize ()

Overrides: UTUIFrontEnd.PostInitialize

PostInitialize event - Sets delegates for the scene.

SceneDeactivated

event SceneDeactivated ()

Overrides: UIScene.SceneDeactivated

Called just after this scene is removed from the active scenes array

Other instance functions

HandleInputKey

function bool HandleInputKey (const out UIRoot.InputEventParameters EventParms)

Overrides: UTUIFrontEnd.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.

NotifyOnlineServiceStatusChanged

function NotifyOnlineServiceStatusChanged (OnlineSubsystem.EOnlineServerConnectionStatus NewConnectionStatus)

Overrides: UIScene.NotifyOnlineServiceStatusChanged

Notification that the player's connection to the platform's online service is changed.

OnAcceptFilterOptions

function OnAcceptFilterOptions (int PlayerIndex)

Called when the user accepts their filter settings and wants to go to the server browser.

OnButtonBar_Back

function bool OnButtonBar_Back (UIScreenObject InButton, int PlayerIndex)

OnButtonBar_Search

function bool OnButtonBar_Search (UIScreenObject InButton, int PlayerIndex)

Buttonbar Callbacks.

OnMainRegion_Show_UIAnimEnd

function OnMainRegion_Show_UIAnimEnd (UIObject AnimTarget, int AnimIndex, UIAnimationSeq AnimSeq)

Overrides: UTUIFrontEnd.OnMainRegion_Show_UIAnimEnd

Handler for the 'show' animation completed.

OnPageActivated

function OnPageActivated (UITabControl Sender, UITabPage NewlyActivePage, int PlayerIndex)

Overrides: UTUIFrontEnd.OnPageActivated

Called when the server browser page is activated. Begins a server list query if the page was activated by the user clicking directly on the server browser's tab (as opposed clicking the Search button or pressing enter or something).

Parameters:

• Sender - the tab control that activated the page
• NewlyActivePage - the page that was just activated
• PlayerIndex - the index [into the Engine.GamePlayers array] for the player that generated this event.

OnServerBrowser_Back

function OnServerBrowser_Back ()

Called when the user wants to back out of the server browser.

OnServerFilter_AcceptOptions

function OnServerFilter_AcceptOptions (UIScreenObject InObject, int PlayerIndex)

Called when the user accepts their filter settings and wants to go to the server browser.

OnServerHistory_AddToFavorite

function OnServerHistory_AddToFavorite ()

Handler for when user moves a server from the server history tab to the server favorites tab; refreshes the server favorites query if the favorites tab is active; otherwise flags the server favorites to be requeried the next time that tab is shown

PreSubmitQuery

function PreSubmitQuery (UTUITabPage_ServerBrowser ServerBrowser)

Handler for the sb tab's OnPrepareToSubmitQuery delegate. Publishes all configured settings to the game search object.

ServerBrowserChangedGameType

function ServerBrowserChangedGameType ()

Handler for the server browser panel's OnSwitchedGameType delegate - updates the options in the Filter panel for the newly selected game type.

ServerFilterChangedGameType

function ServerFilterChangedGameType ()

Handler for the server filter panel's OnSwitchedGameType delegate - updates the combo box on the server browser menu

SetupButtonBar

function SetupButtonBar ()

Overrides: UTUIFrontEnd.SetupButtonBar

Sets up the button bar for the scene.

ShowNextTab

function ShowNextTab ()

Shows the next tab page, if we are at the last tab, then we start the game.

ShowPrevTab

function ShowPrevTab ()

Shows the previous tab page, if we are at the first tab, then we close the scene.

UseCampaignMode

function UseCampaignMode ()

Switch to the Campaign filter and show the tab