UE3:UTDataStore_GameSearchDM (UDK)

Object >> UIRoot >> UIDataProvider >> UIDataStore >> UIDataStore_Remote >> UIDataStore_OnlineGameSearch >> UTDataStore_GameSearchBase >> UTDataStore_GameSearchDM

Package:

UTGame

Implemented interfaces:

UIListElementCellProvider, UIListElementProvider

This class in other games:

UT3

This game search data store handles generating and receiving results for internet queries of all gametypes.

Properties

HistoryGameSearchDataStore

Type: UTDataStore_GameSearchHistory

Modifiers: transient

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

HistoryGameSearchDataStoreClass

Type: class<UTDataStore_GameSearchHistory>

Default value: Class'UTGame.UTDataStore_GameSearchHistory'

StoredGameSearchValues

Type: array<GameSearchSettingsStorage>

Modifiers: config

the list of search parameter values per game search configuration

Default values

Property	Value
GameSearchCfgList[0]	Member Value DefaultGameSettingsClass Class'UTGame.UTGameSettingsDM' GameSearchClass Class'UTGame.UTGameSearchDM' SearchName 'UTGameSearchDM' SearchResultsProviderClass Class'UTGame.UTUIDataProvider_SearchResult'
GameSearchCfgList[1]	Member Value DefaultGameSettingsClass Class'UTGame.UTGameSettingsTDM' GameSearchClass Class'UTGame.UTGameSearchTDM' SearchName 'UTGameSearchTDM' SearchResultsProviderClass Class'UTGame.UTUIDataProvider_SearchResult'
GameSearchCfgList[2]	Member Value DefaultGameSettingsClass Class'UTGame.UTGameSettingsCTF' GameSearchClass Class'UTGame.UTGameSearchCTF' SearchName 'UTGameSearchCTF' SearchResultsProviderClass Class'UTGame.UTUIDataProvider_SearchResult'
GameSearchCfgList[3]	Member Value DefaultGameSettingsClass Class'UTGame.UTGameSettingsVCTF' GameSearchClass Class'UTGame.UTGameSearchVCTF' SearchName 'UTGameSearchVCTF' SearchResultsProviderClass Class'UTGame.UTUIDataProvider_SearchResult'
Tag	'UTGameSearch'

Structs

GameSearchSettingsStorage

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

name GameSearchName

the name of the game search configuration

array<PersistentLocalizedSettingValue> StoredValues

the list of stored values

PersistentLocalizedSettingValue

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

int SettingId

the ID of the setting

int ValueId

the id of the value

Functions

Events

Registered

event Registered (LocalPlayer PlayerOwner)

Overrides: UIDataStore.Registered

(Description copied from UIDataStore.Registered)
Called when this data store is added to the data store manager's list of active data stores.

Parameters:

• PlayerOwner - the player that will be associated with this DataStore. Only relevant if this data store is associated with a particular player; NULL if this is a global data store.

SubmitGameSearch

event bool SubmitGameSearch (byte ControllerIndex, optional bool bInvalidateExistingSearchResults)

Overrides: UTDataStore_GameSearchBase.SubmitGameSearch

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.

Parameters:

• ControllerIndex - the ControllerId for the player to perform the search for
• 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

Returns:

TRUE if the search call works, FALSE otherwise

Other instance functions

FindStoredSearchIndex

function int FindStoredSearchIndex (name GameSearchName)

Finds the index of the saved parameters for the specified game search.

Parameters:

• GameSearchName - the name of the game search to find saved parameters for

Returns:

the index for the saved parameters associated with the specified gametype, or INDEX_NONE if not found.

FindStoredSettingValueIndex

function int FindStoredSettingValueIndex (int StoredGameSearchIndex, int LocalizedSettingId, optional bool bAddIfNecessary)

Find the index for the specified setting in a game search configuration's saved parameters.

Parameters:

• StoredGameSearchIndex - the index of the game search configuration to lookup
• LocalizedSettingId - the id of the setting to find the value for
• 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

Returns:

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

function bool HasOutstandingQueries (optional bool bRestrictCheckToSelf)

Overrides: UTDataStore_GameSearchBase.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.

LoadGameSearchParameters

function LoadGameSearchParameters ()

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

SaveGameSearchParameters

function SaveGameSearchParameters ()

Saves the user selected game search options to disk.