UTGame.UTDataStore_GameSearchBase

Extends

UIDataStore_OnlineGameSearch

Modifiers

native ( UI ) abstract

UT specific data store base class for online game searches. Copyright 2006-2007 Epic Games, Inc. All Rights Reserved.

Core.Object
|   
+-- Engine.UIRoot
   |   
   +-- Engine.UIDataProvider
      |   
      +-- Engine.UIDataStore
         |   
         +-- Engine.UIDataStore_Remote
            |   
            +-- Engine.UIDataStore_OnlineGameSearch
               |   
               +-- UTGame.UTDataStore_GameSearchBase

Direct Known Subclasses:

UTDataStore_GameSearchDM, UTDataStore_GameSearchHistory

Functions Summary
	bool	GetEnabledMutators (out array<int> MutatorIndices)
	bool	HasExistingSearchResults ()))
	bool	HasOutstandingQueries (optional bool bRestrictCheckToSelf ))
		Init ()))
		OnSearchComplete (bool bWasSuccessful))
	bool	SubmitGameSearch (byte ControllerIndex, optional bool bInvalidateExistingSearchResults=true))

ServerDetailsProvider Source code

Reference to the dataprovider that will provide details for a specific search result.

GetEnabledMutators Source code

Retrieves the list of currently enabled mutators.
@param MutatorIndices indices are from the list of UTUIDataProvider_Mutator data providers in the UTUIDataStore_MenuItems data store which are currently enabled.
@return TRUE if the list of enabled mutators was successfully retrieved.

HasExistingSearchResults Source code

@return TRUE if the current game search has completed a query.

HasOutstandingQueries Source code

@param bRestrictCheckToSelf if TRUE, will not check related game search data stores for outstanding queries.
@return TRUE if a server list query was started but has not completed yet.

Init Source code

Registers the delegate with the online subsystem

OnSearchComplete Source code

Called by the online subsystem when the game search has completed
@param bWasSuccessful true if the async action completed without error, false if there was an error

SubmitGameSearch Source code

Called to kick off an online game search and set up all of the delegates needed
@param ControllerIndex the ControllerId for the player to perform the search for
@param bInvalidateExistingSearchResults specify FALSE to keep previous searches (i.e. for other gametypes) in memory; default behavior is to clear all search results when switching to a different item in the game search list
@return TRUE if the search call works, FALSE otherwise

defaultproperties
{
   Name="Default__UTDataStore_GameSearchBase"
   ObjectArchetype=UIDataStore_OnlineGameSearch'Engine.Default__UIDataStore_OnlineGameSearch'
}