UTGame.UTDataStore_GameSearchHistory

Extends

UTDataStore_GameSearchBase

Modifiers

config ( Game )

This specialized online game search data store provides the UI access to the search query and results for the player's most recently visited servers. It is aware of the main game search data store, and ensures that the main search data store is not busy before allowing any action to take place. Copyright 2007 Epic Games, Inc. All Rights Reserved

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

Functions Summary
		AddServer (int ControllerId, UniqueNetId IdToAdd ))
	int	FindServerIndexById (int ControllerId, const out UniqueNetId IdToFind ))
	int	FindServerIndexByString (int ControllerId, string IdToFind ))
	string	GetPlayerName (optional int ControllerId=0 ))
	bool	GetPlayerNetId (out UniqueNetId out_PlayerId, optional int ControllerId=0 ))
		GetServerHistoryIdList (out array out_ServerList ))
		GetServerHistoryStringList (out array out_ServerList ))
	bool	HasOutstandingQueries (optional bool bRestrictCheckToSelf ))
	bool	OverrideQuerySubmission (byte ControllerId, OnlineGameSearch Search ))
		RemoveServer (int ControllerId, UniqueNetId IdToRemove ))

MAX_SERVERHISTORY Source code

the maximum number of most recently visited servers that will be retained

PrimaryGameSearchDataStore Source code

reference to the main game search data store

ServerHistory[MAX_SERVERHISTORY] Source code

AddServer Source code

Add a server to the server history list. Places the server at position 0; if the server already exists in the list elsewhere, it is moved to position 0.
@param ControllerId the index of the controller associated with the logged in player.
@param IdToFind the UniqueNetId for the server to add

FindServerIndexById Source code

Find the index [into the server history list] of the specified server.
@param ControllerId the index of the controller associated with the logged in player.
@param IdToFind the UniqueNetId for the server to find
@return the index [into the server history list] for the specified server

FindServerIndexByString Source code

Find the index [into the server history list] of the specified server.
@param ControllerId the index of the controller associated with the logged in player.
@param IdToFind the UniqueNetId for the server to find
@return the index [into the server history list] for the specified server

GetPlayerName Source code

Retrieve the name of the currently logged in profile.
@param ControllerId the index of the controller associated with the logged in player.
@return the name of the currently logged in player.

GetPlayerNetId Source code

Retrieve the UniqueNetId for the currently logged in player.
@param out_PlayerId receives the value of the logged in player's UniqueNetId
@param ControllerId the index of the controller associated with the logged in player.
@return TRUE if the logged in player's UniqueNetId was successfully retrieved.

GetServerHistoryIdList Source code

Retrieve the list of most recently visited servers.
@param out_ServerList receives the list of UniqueNetIds for the most recently visited servers.

GetServerHistoryStringList Source code

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.

OverrideQuerySubmission Source code

Worker for SubmitGameSeach; allows child classes to perform additional work before the query is submitted.
@param ControllerId the index of the controller for the player to perform the search for.
@param Search the search object that will be used to generate the query.
@return TRUE to prevent SubmitGameSeach from submitting the search (such as when you do this step yourself).

RemoveServer Source code

Removes the specified server from the server history list.
@param ControllerId the index of the controller associated with the logged in player.
@param IdToRemove the UniqueNetId for the server to remove

defaultproperties
{
   GameSearchCfgList(0)=(GameSearchClass=Class'UTGame.UTGameSearchHistory',DefaultGameSettingsClass=Class'UTGame.UTGameSettingsHistory',SearchResultsProviderClass=Class'UTGame.UTUIDataProvider_SearchResult',SearchName="UTGameSearchHistory")
   Tag="UTGameHistory"
   Name="Default__UTDataStore_GameSearchHistory"
   ObjectArchetype=UTDataStore_GameSearchBase'UTGame.Default__UTDataStore_GameSearchBase'
}