Once I get that upgrade to 36-hour days, I will tackle that. – Mychaeel

From Unreal Wiki, The Unreal Engine Documentation Site

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

Package: 

UTGame

Implemented interfaces: 

UIListElementCellProvider, UIListElementProvider

This class in other games:

UDK

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

Copyright 1998-2008 Epic Games, Inc. All Rights Reserved.

[edit] Constants

See UTDataStore_GameSearchDM constants.

[edit] Properties

[edit] AdditionalMutClassFilters

Type: array<UTUIFrontEnd_BrowserMutatorFilters.EMutFilterList>

[edit] AdditionalMutNameFilters

Type: array<UTUIFrontEnd_BrowserMutatorFilters.EMutFilterList>

[edit] bMutatorFilterSet

Type: bool

[edit] CustomGameTypeClass

Type: string

Modifiers: transient

When a custom gametype is selected in the server browser, this value is set to the gametypes class, and is used to properly filter that gametype

[edit] FindGameSearchDataStore

Type: UTDataStore_GameSearchFind

Modifiers: transient

Reference to the data store which handles the 'Find IP' and 'Add IP' IP search queries

[edit] HistoryGameSearchDataStore

Type: UTDataStore_GameSearchHistory

Modifiers: transient

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

[edit] HistoryGameSearchDataStoreClass

Type: class<UTDataStore_GameSearchHistory>

Default value: Class'UTGame.UTDataStore_GameSearchHistory'

[edit] InstalledMutFilters

Type: array<UTUIFrontEnd_BrowserMutatorFilters.EMutFilterList>

These lists are cached here for use by the mutator filter menu

[edit] MutatorFilters

Type: array<MutatorFilter>

If 'MutatorFilterSetting' is set to ML_Custom, then servers must match the list of mutator filter settings defined here

[edit] MutatorFilterSetting

Type: UTUIFrontEnd_BrowserMutatorFilters.EMutatorList

Can be set to ML_NoMutators (no mutators must be running), ML_AnyMutators (doesn't matter what mutators are running) and ML_Custom (checks MutatorFilters)

Default value: ML_AnyMutators

[edit] StoredGameSearchValues

Type: array<GameSearchSettingsStorage>

Modifiers: config

the list of search parameter values per game search configuration

[edit] Default values

[edit] Structs

[edit] 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

[edit] MutatorFilter

Struct for defining a mutator filter setting

string MutatorClass 

Classname of the mutator (must not include package name)

bool bMutatorName 

If true, MutatorClass represents a mutator name instead of class

int OfficialMutValue 

If this is non-zero, then MutatorClass is ignored and this is treated as an official mutator

bool bMustBeOn 

If true, the mutator must be enabled on the server, otherwise it must be disabled

[edit] 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

[edit] Functions

[edit] Events

[edit] Registered

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.

[edit] SetCurrentByIndex

Overrides: UIDataStore_OnlineGameSearch.SetCurrentByIndex

(Description copied from UIDataStore_OnlineGameSearch.SetCurrentByIndex)
Sets the index into the list of game search to use

Parameters:

• NewIndex - the new index to use
• 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

[edit] SetCurrentByName

Overrides: UIDataStore_OnlineGameSearch.SetCurrentByName

(Description copied from UIDataStore_OnlineGameSearch.SetCurrentByName)
Sets the index into the list of game settings to use

Parameters:

• SearchName - the name of the search to find
• 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

[edit] SubmitGameSearch

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 and sets up extra filters.

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

[edit] Other instance functions

[edit] FindStoredSearchIndex

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.

[edit] FindStoredSettingValueIndex

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.

[edit] GetEnabledMutators

Overrides: UTDataStore_GameSearchBase.GetEnabledMutators

these have been moved up a class and are left like this for binary compatibility

[edit] HasExistingSearchResults

Overrides: UTDataStore_GameSearchBase.HasExistingSearchResults

(Description copied from UTDataStore_GameSearchBase.HasExistingSearchResults)

Returns:

TRUE if the current game search has completed a query.

[edit] HasOutstandingQueries

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.

[edit] LoadGameSearchParameters

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

[edit] NoOfficialMuts

[edit] OfficialMutDisabled

[edit] OfficialMutEnabled

[edit] SaveGameSearchParameters

Saves the user selected game search options to disk.