Engine.UIDataStore_OnlineGameSearch

Extends

UIDataStore_Remote

Modifiers

native ( inherit ) implements ( UIListElementProvider , UIListElementCellProvider ) abstract dependson ( OnlineGameSearch ) transient

This class is responsible for mapping properties in an OnlineGameSearch object to something that the UI system can consume. It exposes two things DesiredSettings and SearchResults. DesiredSettings is just publishes the properties/string settings of an online game settings and SearchResults is the set of games found by the search. NOTE: Each game needs to derive at least one class from this one in order to expose the game's specific search class(es)

Core.Object
|   
+-- Engine.UIRoot
   |   
   +-- Engine.UIDataProvider
      |   
      +-- Engine.UIDataStore
         |   
         +-- Engine.UIDataStore_Remote
            |   
            +-- Engine.UIDataStore_OnlineGameSearch

Direct Known Subclasses:

UTDataStore_GameSearchBase

Functions Summary
		AddJoinableOfflineServer (const out string OwningPlayerId, const out string ServerName, const out string ServerIP)
		AddOfflineServer (const out string OwningPlayerId, const out string ServerName)
		BuildSearchResults ()
		ClearAllSearchResults ()))
	int	FindSearchConfigurationIndex (name SearchTag ))
	OnlineGameSearch	GetActiveGameSearch ()))
	OnlineGameSearch	GetCurrentGameSearch ()))
	bool	GetSearchResultFromIndex (int ListIndex, ut OnlineGameSearchResult Result))
		Init ()))
	bool	InvalidateCurrentSearchResults ()))
		MoveToNext (optional bool bInvalidateExistingSearchResults=true))
		MoveToPrevious (optional bool bInvalidateExistingSearchResults=true))
		OnSearchComplete (bool bWasSuccessful))
	bool	OverrideQuerySubmission (byte ControllerId, OnlineGameSearch Search ))
		SetCurrentByIndex (int NewIndex, optional bool bInvalidateExistingSearchResults=true))
		SetCurrentByName (name SearchName, optional bool bInvalidateExistingSearchResults=true))
	bool	ShowHostGamercard (byte ControllerIndex, nt ListIndex))
	bool	SubmitGameSearch (byte ControllerIndex, optional bool bInvalidateExistingSearchResults=true))

ActiveSearchIndex Source code

the index into the set of providers/searches for the query that is currently active

GameInterface Source code

Cached game interface pointer

GameSearchCfgList Source code

The set of game searches and results

OnlineSub Source code

Cached online subsystem pointer

SearchResultsName Source code

Cached FName for faster compares

SelectedIndex Source code

The index into the set of providers/searches for the query that the user most recently requested

GameSearchCfg Source code

Holds the items needed for keeping a list of game searches around
DefaultGameSettingsClass:

The OnlineGameSettings derived class to use as the default data

DesiredSettingsProvider:

Publishes the desired settings from the game search object

GameSearchClass:

The OnlineGameSeach derived class to load and populate the UI with

Search:

OnlineGameSearch object that will be exposed to the UI

SearchName:

For finding via name

SearchResults:

Array of providers that handle the search results

SearchResultsProviderClass:

The data provider to use for each search result that is returned. Useful when a game wishes to create "meta" properties from search results.

AddJoinableOfflineServer Source code

As above, but allows you to provide an IP address for the server; which can be used to attempt a direct connect

AddOfflineServer Source code

Adds an offline placeholder server to the list of results Used to keep history and favorites in the list after a search comes back without them
@param OwningPlayerId the id of the player who created this server (last known)
@param ServerName the description of the server (last known)

BuildSearchResults Source code

Tells this provider to rebuild it's array data

ClearAllSearchResults Source code

Attempts to clear the server query results for all gametypes

FindSearchConfigurationIndex Source code

Find the index of the search configuration element which has the specified tag.
@param SearchTag the name of the search configuration to find
@return the index of the search configuration with a tag matching the input value or INDEX_NONE if none were found.

GetActiveGameSearch Source code

returns the game search object that last submitted a server query

GetCurrentGameSearch Source code

Returns the game search object that is currently selected

GetSearchResultFromIndex Source code

Returns the search result for the list index specified
@param ListIndex the index to find the result for
@return the search results (empty if out of bounds)

Init Source code

Registers the delegate with the online subsystem

InvalidateCurrentSearchResults Source code

Attempts to free the results from the last search that was submitted.

MoveToNext Source code

Moves to the next item in the list
@param 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

MoveToPrevious Source code

Moves to the previous item in the list
@param 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

OnSearchComplete Source code

Called by the online subsystem when the game search has completed
@param bWasSuccessful true if the async action completed without error, false if there was an error

OverrideQuerySubmission Source code

Worker for SubmitGameSeach; allows child classes to perform additional work before the query is submitted.
@param ControllerId the index of the controller for the player to perform the search for.
@param Search the search object that will be used to generate the query.
@return TRUE to prevent SubmitGameSeach from submitting the search (such as when you do this step yourself).

SetCurrentByIndex Source code

Sets the index into the list of game search to use
@param NewIndex the new index to use
@param 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 Source code

Sets the index into the list of game settings to use
@param SearchName the name of the search to find
@param 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

ShowHostGamercard Source code

Displays the gamercard for the specified host
@param ControllerIndex the ControllerId for the player displaying the gamercard
@param ListIndex the item in the list to display the gamercard for

SubmitGameSearch Source code

Called to kick off an online game search and set up all of the delegates needed
@param ControllerIndex the ControllerId for the player to perform the search for
@param 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
@return TRUE if the search call works, FALSE otherwise

defaultproperties
{
   SearchResultsName="SearchResults"
   ActiveSearchIndex=-1
   Tag="OnlineGameSearch"
   WriteAccessType=ACCESS_WriteAll
   Name="Default__UIDataStore_OnlineGameSearch"
   ObjectArchetype=UIDataStore_Remote'Engine.Default__UIDataStore_Remote'
}