Mostly Harmless

UE3:UTDataStore_GameSearchDM (UT3)

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
UT3 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 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.

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

Constants

See UTDataStore_GameSearchDM constants.

Properties

AdditionalMutClassFilters

Type: array<UTUIFrontEnd_BrowserMutatorFilters.EMutFilterList>


AdditionalMutNameFilters

Type: array<UTUIFrontEnd_BrowserMutatorFilters.EMutFilterList>


bMutatorFilterSet

Type: bool


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

FindGameSearchDataStore

Type: UTDataStore_GameSearchFind

Modifiers: transient

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

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'

InstalledMutFilters

Type: array<UTUIFrontEnd_BrowserMutatorFilters.EMutFilterList>

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

MutatorFilters

Type: array<MutatorFilter>

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

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

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'
GameSearchCfgList[4]
Member Value
DefaultGameSettingsClass Class'UTGame.UTGameSettingsWAR'
GameSearchClass Class'UTGame.UTGameSearchWAR'
SearchName 'UTGameSearchWAR'
SearchResultsProviderClass Class'UTGame.UTUIDataProvider_SearchResult'
GameSearchCfgList[5]
Member Value
DefaultGameSettingsClass Class'UTGame.UTGameSettingsDUEL'
GameSearchClass Class'UTGame.UTGameSearchDUEL'
SearchName 'UTGameSearchDUEL'
SearchResultsProviderClass Class'UTGame.UTUIDataProvider_SearchResult'
GameSearchCfgList[6]
Member Value
DefaultGameSettingsClass Class'UTGame.UTGameSettingsCampaign'
GameSearchClass Class'UTGame.UTGameSearchCampaign'
SearchName 'UTGameSearchCampaign'
SearchResultsProviderClass Class'UTGame.UTUIDataProvider_SearchResult'
GameSearchCfgList[7]
Member Value
DefaultGameSettingsClass Class'UTGame.UTGameSettingsDM'
GameSearchClass Class'UTGame.UTGameSearchCustom'
SearchName 'UTGameSearchCustom'
SearchResultsProviderClass Class'UTGame.UTUIDataProvider_SearchResult'
GameSearchCfgList[8]
Member Value
DefaultGameSettingsClass Class'UTGame.UTGameSettingsGreed'
GameSearchClass Class'UTGame.UTGameSearchGreed'
SearchName 'UTGameSearchGreed'
SearchResultsProviderClass Class'UTGame.UTUIDataProvider_SearchResult'
GameSearchCfgList[9]
Member Value
DefaultGameSettingsClass Class'UTGame.UTGameSettingsBetrayal'
GameSearchClass Class'UTGame.UTGameSearchBetrayal'
SearchName 'UTGameSearchBetrayal'
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

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

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.

SetCurrentByIndex

event SetCurrentByIndex (int NewIndex, optional bool bInvalidateExistingSearchResults)

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

SetCurrentByName

event SetCurrentByName (name SearchName, optional bool bInvalidateExistingSearchResults)

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

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 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

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.

GetEnabledMutators

function bool GetEnabledMutators (out array<int> MutatorIndices)

Overrides: UTDataStore_GameSearchBase.GetEnabledMutators

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

HasExistingSearchResults

function bool HasExistingSearchResults ()

Overrides: UTDataStore_GameSearchBase.HasExistingSearchResults

(Description copied from UTDataStore_GameSearchBase.HasExistingSearchResults)


Returns:

TRUE if the current game search has completed a query.

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.

NoOfficialMuts

final function bool NoOfficialMuts (string PropertyValue, string ComparedValue)


OfficialMutDisabled

final function bool OfficialMutDisabled (string PropertyValue, string ComparedValue)


OfficialMutEnabled

final function bool OfficialMutEnabled (string PropertyValue, string ComparedValue)


SaveGameSearchParameters

function SaveGameSearchParameters ()

Saves the user selected game search options to disk.

Retrieved from "https://wiki.beyondunreal.com/UE3:UTDataStore_GameSearchDM_(UT3)?oldid=35119"