UE3:UTDataStore_GameSearchFind (UT3)

Object >> UIRoot >> UIDataProvider >> UIDataStore >> UIDataStore_Remote >> UIDataStore_OnlineGameSearch >> UTDataStore_GameSearchBase >> UTDataStore_GameSearchPersonal >> UTDataStore_GameSearchFind

Package: 

UTGame

Implemented interfaces: 

UIListElementCellProvider, UIListElementProvider

This data store class provides query and search results for the UTQueryHelper class. This is a stripped down version of the history/favourites data store, which searches for servers based upon port and IP.

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

Properties

HistoryGameSearchDataStore

Type: UTDataStore_GameSearchHistory

Modifiers: transient

SearchIP

Type: string

SearchPort

Type: string

Default values

Property	Value
GameSearchCfgList[0]	Member Value DefaultGameSettingsClass Class'UTGame.UTGameSettingsPersonal' GameSearchClass Class'UTGame.UTGameSearchPersonal' SearchName 'UTGameSearchFind' SearchResultsProviderClass Class'UTGame.UTUIDataProvider_SearchResult'
Tag	'UTGameFind'

Delegates

OnSetupQueryFilters

delegate bool OnSetupQueryFilters (OnlineGameSearch Search)

Instance functions

HasOutstandingQueries

function bool HasOutstandingQueries (optional bool bRestrictCheckToSelf)

Overrides: UTDataStore_GameSearchPersonal.HasOutstandingQueries

Parameters:

• bRestrictCheckToSelf - if TRUE, will not check related game search data stores for outstanding queries.

Returns:

TRUE if a server list query was started but has not completed yet.

OnSearchComplete

function OnSearchComplete (bool bWasSuccessful)

Overrides: UTDataStore_GameSearchPersonal.OnSearchComplete

(Description copied from UTDataStore_GameSearchPersonal.OnSearchComplete)
Called by the online subsystem when the game search has completed

Parameters:

• bWasSuccessful - true if the async action completed without error, false if there was an error

OverrideQuerySubmission

protected function bool OverrideQuerySubmission (byte ControllerId, OnlineGameSearch Search)

Overrides: UTDataStore_GameSearchPersonal.OverrideQuerySubmission

(Description copied from UTDataStore_GameSearchPersonal.OverrideQuerySubmission)
Worker for SubmitGameSeach; allows child classes to perform additional work before the query is submitted.

Parameters:

• ControllerId - the index of the controller for the player to perform the search for.
• Search - the search object that will be used to generate the query.

Returns:

TRUE to prevent SubmitGameSeach from submitting the search (such as when you do this step yourself).