I search for solutions in this order: Past Code, Unreal Source, Wiki, BUF, groups.yahoo, google, screaming at monitor. – RegularX

UE3:UTQueryHelper (UT3)

From Unreal Wiki, The Unreal Engine Documentation Site

Jump to: navigation, search
UT3 Object >> UIRoot >> Interaction >> UTQueryHelper

Contents
Package: 
UTGame
This is an auto-generated page and may need human attention.
Please remove this 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

[edit] Constants

See UTQueryHelper constants.

[edit] Properties

[edit] bDisplayQueryMessage

Type: bool


[edit] bInitialized

Type: bool


[edit] bJoinSpectate

Type: bool


[edit] bQueryInProgress

Type: bool


[edit] CurSearchResultIdx

Type: int

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

Default value: -1

[edit] DirectConnectURL

Type: string


[edit] GameInterface

Type: OnlineGameInterface


[edit] JoinPassword

Type: string


[edit] LastError

Type: EQueryError


[edit] SceneRef

Type: UTUIScene


[edit] SearchDataStore

Type: UTDataStore_GameSearchFind


[edit] SearchIP

Type: string


[edit] SearchPort

Type: string


[edit] Enums

[edit] EQueryError

QE_None 
QE_Uninitialized 
QE_QueryInProgress 
QE_NotLoggedIn 
QE_InvalidIP 
QE_InvalidResult 
QE_JoinFailed 
QE_Custom 

[edit] Delegates

[edit] OnFindServerByIPComplete

delegate OnFindServerByIPComplete (OnlineGameSearch.OnlineGameSearchResult Result)


[edit] Functions

[edit] Static functions

[edit] GetQueryHelper

static final function UTQueryHelper GetQueryHelper (UTUIScene InScene)


[edit] Instance functions

[edit] BeginJoin

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


[edit] DisplayFindIPError

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


[edit] FindServerByIP

function bool FindServerByIP (string Address, optional bool bQueryMessageBox)


[edit] Initialize

function Initialize ()


[edit] JoinServerByIP

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


[edit] JoinServerBySearchResult

function JoinServerBySearchResult (OnlineGameSearch.OnlineGameSearchResult Result)


[edit] OnCancelFindOnlineGames

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


[edit] OnCancelFindOnlineGamesComplete

function OnCancelFindOnlineGamesComplete (bool bWasSuccessful)


[edit] OnFindIPErrorDialog_Closed

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


[edit] OnFindOnlineGamesComplete

function OnFindOnlineGamesComplete (bool bWasSuccessful)


[edit] OnFindOnlineGamesUpdate

function OnFindOnlineGamesUpdate (bool bWasSuccessful)


[edit] OnJoinGameComplete

function OnJoinGameComplete (bool bSuccessful)


[edit] OnPasswordDialogClosed

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


[edit] OnSetupQueryFilters

function bool OnSetupQueryFilters (OnlineGameSearch Search)


[edit] Release

singular function Release ()


[edit] States

[edit] FindIPQuery

Extends: QueryBase

[edit] FindIPQuery.OnFindOnlineGamesComplete

function OnFindOnlineGamesComplete (bool bWasSuccessful)

Overrides: OnFindOnlineGamesComplete (global)


[edit] FindIPQuery.OnSetupQueryFilters

function bool OnSetupQueryFilters (OnlineGameSearch Search)

Overrides: OnSetupQueryFilters (global)


[edit] JoinServerQuery

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

[edit] JoinServerQuery.BeginJoin

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

Overrides: BeginJoin (global)


[edit] JoinServerQuery.JoinServerBySearchResult

function JoinServerBySearchResult (OnlineGameSearch.OnlineGameSearchResult Result)

Overrides: JoinServerBySearchResult (global)


[edit] JoinServerQuery.OnJoinGameComplete

function OnJoinGameComplete (bool bSuccessful)

Overrides: OnJoinGameComplete (global)


[edit] JoinServerQuery.OnPasswordDialogClosed

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

Overrides: OnPasswordDialogClosed (global)


[edit] QueryBase

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

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

[edit] QueryBase.OnCancelFindOnlineGames

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

Overrides: OnCancelFindOnlineGames (global)


[edit] QueryBase.OnCancelFindOnlineGamesComplete

function OnCancelFindOnlineGamesComplete (bool bWasSuccessful)

Overrides: OnCancelFindOnlineGamesComplete (global)


[edit] QueryBase.OnFindOnlineGamesUpdate

function OnFindOnlineGamesUpdate (bool bWasSuccessful)

Overrides: OnFindOnlineGamesUpdate (global)


Retrieved from "http://wiki.beyondunreal.com/UE3:UTQueryHelper_(UT3)"