My program doesn't have bugs. It just develops random features.
UE3:UTDataStore_GameSearchDM (UDK)
Object >> UIRoot >> UIDataProvider >> UIDataStore >> UIDataStore_Remote >> UIDataStore_OnlineGameSearch >> UTDataStore_GameSearchBase >> UTDataStore_GameSearchDM |
Contents
- Package:
- UTGame
- Implemented interfaces:
- UIListElementCellProvider, UIListElementProvider
- This class in other games:
- UT3
This is an auto-generated page and may need human attention. Please remove the {{autogenerated}} tag if the page seems reasonably complete or replace it with the {{expand}} tag if the page is not yet complete. |
This game search data store handles generating and receiving results for internet queries of all gametypes.
Properties[edit]
HistoryGameSearchDataStore[edit]
Type: UTDataStore_GameSearchHistory
Modifiers: transient
Reference to the search data store that handles the player's list of most recently visited servers
HistoryGameSearchDataStoreClass[edit]
Type: class<UTDataStore_GameSearchHistory>
Default value: Class'UTGame.UTDataStore_GameSearchHistory'
StoredGameSearchValues[edit]
Type: array<GameSearchSettingsStorage>
Modifiers: config
the list of search parameter values per game search configuration
Default values[edit]
Property | Value | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
GameSearchCfgList[0] |
|
||||||||||
GameSearchCfgList[1] |
|
||||||||||
GameSearchCfgList[2] |
|
||||||||||
GameSearchCfgList[3] |
|
||||||||||
Tag | 'UTGameSearch' |
Structs[edit]
GameSearchSettingsStorage[edit]
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[edit]
A simple mapping of localized setting ID to a localized setting value ID.
Functions[edit]
Events[edit]
Registered[edit]
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[edit]
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[edit]
FindStoredSearchIndex[edit]
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[edit]
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[edit]
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[edit]
Loads the saved game search parameters from disk and initializes the game search objects with the previously selected values.
SaveGameSearchParameters[edit]
Saves the user selected game search options to disk.