My program doesn't have bugs. It just develops random features.

UE3:UTDataStore_GameSearchFind (UT3)

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
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[edit]

HistoryGameSearchDataStore[edit]

Type: UTDataStore_GameSearchHistory

Modifiers: transient


SearchIP[edit]

Type: string


SearchPort[edit]

Type: string


Default values[edit]

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

Delegates[edit]

OnSetupQueryFilters[edit]

delegate bool OnSetupQueryFilters (OnlineGameSearch Search)


Instance functions[edit]

HasOutstandingQueries[edit]

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

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

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).