Cogito, ergo sum

UE3:UTUIFrontEnd_QuickMatch (UT3)

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
UT3 Object >> UIRoot >> UIScreenObject >> UIScene >> UTUIScene >> UTUIFrontEnd >> UTUIFrontEnd_QuickMatch
Package: 
UTGame

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

Allows the user to pick a bunch of filters and then jump straight into a game.

Properties[edit]

bSearching[edit]

Type: bool

Whether or not we are currently searching.

FindQuickMatchTab[edit]

Type: UTUITabPage_FindQuickMatch

Modifiers: transient


SearchingMessageBox[edit]

Type: UTUIScene_MessageBox

Modifiers: transient

Reference to the searching messagebox.

ServerFilterTab[edit]

Type: UTUITabPage_ServerFilter

Modifiers: transient

Tab page references for this scene.

Default values[edit]

Property Value
bMenuLevelRestoresScene True
bRequiresNetwork True

Subobjects[edit]

SceneEventComponent[edit]

Class: Engine.UIComp_Event

Inherits from: UTUIFrontEnd.SceneEventComponent

No new values.

Functions[edit]

Events[edit]

PostInitialize[edit]

event PostInitialize ()

Overrides: UTUIFrontEnd.PostInitialize

PostInitialize event - Sets delegates for the scene.

SceneActivated[edit]

event SceneActivated (bool bInitialActivation)

Overrides: UTUIFrontEnd.SceneActivated

Callback for when the scene is activated.

Other instance functions[edit]

HandleInputKey[edit]

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.

OnBack[edit]

function OnBack ()

Callback for when the user wants to go back or cancel the current search.

OnButtonBar_Back[edit]

function bool OnButtonBar_Back (UIScreenObject InButton, int PlayerIndex)


OnButtonBar_FindMatch[edit]

function bool OnButtonBar_FindMatch (UIScreenObject InButton, int PlayerIndex)

Buttonbar callbacks.

OnCancelSearch[edit]

function OnCancelSearch (UTUIScene_MessageBox MessageBox, int SelectedItem, int PlayerIndex)

Callback for the user cancelling the search.

OnGameSearchCompleted[edit]

function OnGameSearchCompleted (bool bSuccessful)

Callback for when the g

OnMainRegion_Show_UIAnimEnd[edit]

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

Overrides: UTUIFrontEnd.OnMainRegion_Show_UIAnimEnd

Called when a tab page has finished showing.

OnSearchDialogClosed_Failed[edit]

function OnSearchDialogClosed_Failed ()

Callback for when the search dialog has been closed after a failed search and we need to display an error.

OnSearchDialogClosed_Success[edit]

function OnSearchDialogClosed_Success ()

Callback for when the search dialog has been closed after a successful search and we need to join a game.

OnSearchingMessage_Closed[edit]

function OnSearchingMessage_Closed ()

Callback for when the search message has closed.

OnServerFilter_AcceptOptions[edit]

function OnServerFilter_AcceptOptions (UIScreenObject InObject, int PlayerIndex)

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

SetupButtonBar[edit]

function SetupButtonBar ()

Overrides: UTUIFrontEnd.SetupButtonBar

Setup the button bar for this scene.

StartSearch[edit]

function StartSearch ()

Starts searching for a game.