UTGame.UTDataStore_GameSearchDM

Extends

UDKDataStore_GameSearchBase

Modifiers

config ( UI )

This game search data store handles generating and receiving results for internet queries of all gametypes. Copyright 1998-2011 Epic Games, Inc. All Rights Reserved.

Core.Object
|   
+-- Engine.UIRoot
   |   
   +-- Engine.UIDataProvider
      |   
      +-- Engine.UIDataStore
         |   
         +-- Engine.UIDataStore_Remote
            |   
            +-- Engine.UIDataStore_OnlineGameSearch
               |   
               +-- UDKBase.UDKDataStore_GameSearchBase
                  |   
                  +-- UTGame.UTDataStore_GameSearchDM

Functions Summary
	int	FindStoredSearchIndex (name GameSearchName ))
	int	FindStoredSettingValueIndex (int StoredGameSearchIndex, int LocalizedSettingId, optional bool bAddIfNecessary ))
	bool	HasOutstandingQueries (optional bool bRestrictCheckToSelf ))
		LoadGameSearchParameters ()))
		Registered (LocalPlayer PlayerOwner ))
		SaveGameSearchParameters ()))
	bool	SubmitGameSearch (byte ControllerIndex, optional bool bInvalidateExistingSearchResults=true))

HistoryGameSearchDataStore Source code

Reference to the search data store that handles the player's list of most recently visited servers

HistoryGameSearchDataStoreClass Source code

StoredGameSearchValues Source code

the list of search parameter values per game search configuration

GameSearchSettingsStorage Source code

Stores a list of values ids for a single game search configuration.
GameSearchName:

the name of the game search configuration

StoredValues:

the list of stored values

PersistentLocalizedSettingValue Source code

A simple mapping of localized setting ID to a localized setting value ID.
SettingId:

the ID of the setting

ValueId:

the id of the value

FindStoredSearchIndex Source code

Finds the index of the saved parameters for the specified game search.
@param GameSearchName the name of the game search to find saved parameters for
@return the index for the saved parameters associated with the specified gametype, or INDEX_NONE if not found.

FindStoredSettingValueIndex Source code

Find the index for the specified setting in a game search configuration's saved parameters.
@param StoredGameSearchIndex the index of the game search configuration to lookup
@param LocalizedSettingId the id of the setting to find the value for
@param bAddIfNecessary if the specified setting Id is not found in the saved parameters for the game search config, automatically creates an entry for that setting if this value is TRUE
@return the index of the setting in the game search configuration's saved parameters list of settings, or INDEX_NONE if it doesn't exist.

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.

LoadGameSearchParameters Source code

Loads the saved game search parameters from disk and initializes the game search objects with the previously selected values.

Registered Source code

SaveGameSearchParameters Source code

Saves the user selected game search options to disk.

SubmitGameSearch Source code

Called to kick off an online game search and set up all of the delegates needed; this version saved the search parameters to persistent storage.
@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
{
	Tag=UTGameSearch
	HistoryGameSearchDataStoreClass=class'UTGame.UTDataStore_GameSearchHistory'

	GameSearchCfgList.Empty
	GameSearchCfgList.Add((GameSearchClass=class'UTGame.UTGameSearchDM',DefaultGameSettingsClass=class'UTGame.UTGameSettingsDM',SearchResultsProviderClass=class'UTGame.UTUIDataProvider_SearchResult',SearchName="UTGameSearchDM"))
	GameSearchCfgList.Add((GameSearchClass=class'UTGame.UTGameSearchTDM',DefaultGameSettingsClass=class'UTGame.UTGameSettingsTDM',SearchResultsProviderClass=class'UTGame.UTUIDataProvider_SearchResult',SearchName="UTGameSearchTDM"))
	GameSearchCfgList.Add((GameSearchClass=class'UTGame.UTGameSearchCTF',DefaultGameSettingsClass=class'UTGame.UTGameSettingsCTF',SearchResultsProviderClass=class'UTGame.UTUIDataProvider_SearchResult',SearchName="UTGameSearchCTF"))
	GameSearchCfgList.Add((GameSearchClass=class'UTGame.UTGameSearchVCTF',DefaultGameSettingsClass=class'UTGame.UTGameSettingsVCTF',SearchResultsProviderClass=class'UTGame.UTUIDataProvider_SearchResult',SearchName="UTGameSearchVCTF"))	
}