UE3:UTDataStore_GameSearchBase (UT3)

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

Package: 

UTGame

Implemented interfaces: 

UIListElementCellProvider, UIListElementProvider

Direct subclasses:

UTDataStore_GameSearchDM, UTDataStore_GameSearchPersonal

This class in other games:

UDK

UT specific data store base class for online game searches.

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

Properties

ServerDetailsProvider

Type: UTUIDataProvider_ServerDetails

Modifiers: transient

Reference to the dataprovider that will provide details for a specific search result.

Functions

Native functions

GetEnabledMutators

native function bool GetEnabledMutators (out array<int> MutatorIndices)

Retrieves the list of currently enabled mutators.

Parameters:

• MutatorIndices - indices are from the list of UTUIDataProvider_Mutator data providers in the UTUIDataStore_MenuItems data store which are currently enabled.

Returns:

TRUE if the list of enabled mutators was successfully retrieved.

Events

Init

event Init ()

Overrides: UIDataStore_OnlineGameSearch.Init

Registers the delegate with the online subsystem

SubmitGameSearch

event bool SubmitGameSearch (byte ControllerIndex, optional bool bInvalidateExistingSearchResults)

Overrides: UIDataStore_OnlineGameSearch.SubmitGameSearch

Called to kick off an online game search and set up all of the delegates needed

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

HasExistingSearchResults

function bool HasExistingSearchResults ()

Returns:

TRUE if the current game search has completed a query.

HasOutstandingQueries

function bool HasOutstandingQueries (optional bool bRestrictCheckToSelf)

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.

OnSearchComplete

function OnSearchComplete (bool bWasSuccessful)

Overrides: UIDataStore_OnlineGameSearch.OnSearchComplete

Called by the online subsystem when the game search has completed

Parameters:

• bWasSuccessful - true if the async action completed without error, false if there was an error