UE3:UTQueryHelper (UT3)

Object >> UIRoot >> Interaction >> UTQueryHelper

Package: 

UTGame

A central helper class for performing non-trivial server queries, such as those required by the 'Join IP' and 'Add IP' buttons in the Join Game and Favourites tabs on the server browser.

N.B. This extends Interaction to allow state code execution (Object subclasses don't normally support states)

Copyright 2008 Epic Games, Inc. All Rights Reserved

Constants

See UTQueryHelper constants.

Properties

bDisplayQueryMessage

Type: bool

bInitialized

Type: bool

bJoinSpectate

Type: bool

bQueryInProgress

Type: bool

CurSearchResultIdx

Type: int

Cached search result index; not saved as an 'OnlineGameSearchResult', as that is unsafe

Default value: -1

DirectConnectURL

Type: string

GameInterface

Type: OnlineGameInterface

JoinPassword

Type: string

LastError

Type: EQueryError

SceneRef

Type: UTUIScene

SearchDataStore

Type: UTDataStore_GameSearchFind

SearchIP

Type: string

SearchPort

Type: string

Enums

EQueryError

QE_None 

QE_Uninitialized 

QE_QueryInProgress 

QE_NotLoggedIn 

QE_InvalidIP 

QE_InvalidResult 

QE_JoinFailed 

QE_Custom 

Delegates

OnFindServerByIPComplete

delegate OnFindServerByIPComplete (OnlineGameSearch.OnlineGameSearchResult Result)

Functions

Static functions

GetQueryHelper

static final function UTQueryHelper GetQueryHelper (UTUIScene InScene)

Instance functions

BeginJoin

function BeginJoin (OnlineGameSearch.OnlineGameSearchResult JoinTarget, optional string Password)

DisplayFindIPError

function DisplayFindIPError (optional bool bAskForDirectConnect, optional string InDirectConnectURL, optional EQueryError ErrorType, optional string CustomError)

FindServerByIP

function bool FindServerByIP (string Address, optional bool bQueryMessageBox)

Initialize

function Initialize ()

JoinServerByIP

function JoinServerByIP (string Address, optional bool bQueryMessageBox, optional bool bSpectate, optional string FallbackURL)

JoinServerBySearchResult

function JoinServerBySearchResult (OnlineGameSearch.OnlineGameSearchResult Result)

OnCancelFindOnlineGames

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

OnCancelFindOnlineGamesComplete

function OnCancelFindOnlineGamesComplete (bool bWasSuccessful)

OnFindIPErrorDialog_Closed

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

OnFindOnlineGamesComplete

function OnFindOnlineGamesComplete (bool bWasSuccessful)

OnFindOnlineGamesUpdate

function OnFindOnlineGamesUpdate (bool bWasSuccessful)

OnJoinGameComplete

function OnJoinGameComplete (bool bSuccessful)

OnPasswordDialogClosed

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

OnSetupQueryFilters

function bool OnSetupQueryFilters (OnlineGameSearch Search)

Release

singular function Release ()

States

FindIPQuery

Extends: QueryBase

FindIPQuery.OnFindOnlineGamesComplete

function OnFindOnlineGamesComplete (bool bWasSuccessful)

Overrides: OnFindOnlineGamesComplete (global)

FindIPQuery.OnSetupQueryFilters

function bool OnSetupQueryFilters (OnlineGameSearch Search)

Overrides: OnSetupQueryFilters (global)

JoinServerQuery

JoinServerQuery.EndState

event EndState (name NextStateName)

Overrides: Object.EndState (global)

Called immediately before going out of the current state, while within the GotoState() call that caused the state change, and before BeginState() is called within the new state.

JoinServerQuery.BeginJoin

function BeginJoin (OnlineGameSearch.OnlineGameSearchResult JoinTarget, optional string Password)

Overrides: BeginJoin (global)

JoinServerQuery.JoinServerBySearchResult

function JoinServerBySearchResult (OnlineGameSearch.OnlineGameSearchResult Result)

Overrides: JoinServerBySearchResult (global)

JoinServerQuery.OnJoinGameComplete

function OnJoinGameComplete (bool bSuccessful)

Overrides: OnJoinGameComplete (global)

JoinServerQuery.OnPasswordDialogClosed

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

Overrides: OnPasswordDialogClosed (global)

QueryBase

QueryBase.BeginState

event BeginState (name PreviousStateName)

Overrides: Object.BeginState (global)

Called immediately when entering a state, while within the GotoState() call that caused the state change (before any state code is executed).

QueryBase.EndState

event EndState (name NextStateName)

Overrides: Object.EndState (global)

Called immediately before going out of the current state, while within the GotoState() call that caused the state change, and before BeginState() is called within the new state.

QueryBase.OnCancelFindOnlineGames

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

Overrides: OnCancelFindOnlineGames (global)

QueryBase.OnCancelFindOnlineGamesComplete

function OnCancelFindOnlineGamesComplete (bool bWasSuccessful)

Overrides: OnCancelFindOnlineGamesComplete (global)

QueryBase.OnFindOnlineGamesUpdate

function OnFindOnlineGamesUpdate (bool bWasSuccessful)

Overrides: OnFindOnlineGamesUpdate (global)