Mostly Harmless

UE3:UTQueryHelper (UT3)

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
UT3 Object >> UIRoot >> Interaction >> UTQueryHelper
Package: 
UTGame
This is an auto-generated page and may need human attention.
Please remove the {{autogenerated}} tag if the page seems reasonably complete or replace it with the {{expand}} tag if the page is not yet complete.

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[edit]

See UTQueryHelper constants.

Properties[edit]

bDisplayQueryMessage[edit]

Type: bool


bInitialized[edit]

Type: bool


bJoinSpectate[edit]

Type: bool


bQueryInProgress[edit]

Type: bool


CurSearchResultIdx[edit]

Type: int

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

Default value: -1

DirectConnectURL[edit]

Type: string


GameInterface[edit]

Type: OnlineGameInterface


JoinPassword[edit]

Type: string


LastError[edit]

Type: EQueryError


SceneRef[edit]

Type: UTUIScene


SearchDataStore[edit]

Type: UTDataStore_GameSearchFind


SearchIP[edit]

Type: string


SearchPort[edit]

Type: string


Enums[edit]

EQueryError[edit]

QE_None 
QE_Uninitialized 
QE_QueryInProgress 
QE_NotLoggedIn 
QE_InvalidIP 
QE_InvalidResult 
QE_JoinFailed 
QE_Custom 

Delegates[edit]

OnFindServerByIPComplete[edit]

delegate OnFindServerByIPComplete (OnlineGameSearch.OnlineGameSearchResult Result)


Functions[edit]

Static functions[edit]

GetQueryHelper[edit]

static final function UTQueryHelper GetQueryHelper (UTUIScene InScene)


Instance functions[edit]

BeginJoin[edit]

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


DisplayFindIPError[edit]

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


FindServerByIP[edit]

function bool FindServerByIP (string Address, optional bool bQueryMessageBox)


Initialize[edit]

function Initialize ()


JoinServerByIP[edit]

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


JoinServerBySearchResult[edit]

function JoinServerBySearchResult (OnlineGameSearch.OnlineGameSearchResult Result)


OnCancelFindOnlineGames[edit]

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


OnCancelFindOnlineGamesComplete[edit]

function OnCancelFindOnlineGamesComplete (bool bWasSuccessful)


OnFindIPErrorDialog_Closed[edit]

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


OnFindOnlineGamesComplete[edit]

function OnFindOnlineGamesComplete (bool bWasSuccessful)


OnFindOnlineGamesUpdate[edit]

function OnFindOnlineGamesUpdate (bool bWasSuccessful)


OnJoinGameComplete[edit]

function OnJoinGameComplete (bool bSuccessful)


OnPasswordDialogClosed[edit]

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


OnSetupQueryFilters[edit]

function bool OnSetupQueryFilters (OnlineGameSearch Search)


Release[edit]

singular function Release ()


States[edit]

FindIPQuery[edit]

Extends: QueryBase

FindIPQuery.OnFindOnlineGamesComplete[edit]

function OnFindOnlineGamesComplete (bool bWasSuccessful)

Overrides: OnFindOnlineGamesComplete (global)


FindIPQuery.OnSetupQueryFilters[edit]

function bool OnSetupQueryFilters (OnlineGameSearch Search)

Overrides: OnSetupQueryFilters (global)


JoinServerQuery[edit]

JoinServerQuery.EndState[edit]

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[edit]

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

Overrides: BeginJoin (global)


JoinServerQuery.JoinServerBySearchResult[edit]

function JoinServerBySearchResult (OnlineGameSearch.OnlineGameSearchResult Result)

Overrides: JoinServerBySearchResult (global)


JoinServerQuery.OnJoinGameComplete[edit]

function OnJoinGameComplete (bool bSuccessful)

Overrides: OnJoinGameComplete (global)


JoinServerQuery.OnPasswordDialogClosed[edit]

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

Overrides: OnPasswordDialogClosed (global)


QueryBase[edit]

QueryBase.BeginState[edit]

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[edit]

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[edit]

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

Overrides: OnCancelFindOnlineGames (global)


QueryBase.OnCancelFindOnlineGamesComplete[edit]

function OnCancelFindOnlineGamesComplete (bool bWasSuccessful)

Overrides: OnCancelFindOnlineGamesComplete (global)


QueryBase.OnFindOnlineGamesUpdate[edit]

function OnFindOnlineGamesUpdate (bool bWasSuccessful)

Overrides: OnFindOnlineGamesUpdate (global)


Retrieved from "https://wiki.beyondunreal.com/UE3:UTQueryHelper_(UT3)?oldid=34972"