UE3:UTDataStore_GameSearchPersonal (UT3)

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

Package: 

UTGame

Implemented interfaces: 

UIListElementCellProvider, UIListElementProvider

Direct subclasses:

UTDataStore_GameSearchFavorites, UTDataStore_GameSearchHistory, UTDataStore_GameSearchFind

This class in other games:

UDK

This specialized online game search data store provides the UI access to the search query and results for specific servers that the player wishes to query. It is aware of the main game search data store, and ensures that the main search data store is not busy before allowing any action to take place.

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

Constants

MAX_PERSONALSERVERS

Value: 15

the maximum number of most recently visited servers that will be retained

Properties

PrimaryGameSearchDataStore

Type: UTDataStore_GameSearchDM

Modifiers: transient

reference to the main game search data store

ServerList

Type: ServerEntry

Array size: 15 (MAX_PERSONALSERVERS)

Modifiers: config

the list of servers stored in this data store

Default values

Property	Value
Tag	'UTGameSearchPersonal'

Structs

ServerEntry

Modifiers: native

string ServerUniqueId 

string ServerName 

Instance functions

AddServer

function bool AddServer (int ControllerId, OnlineSubsystem.UniqueNetId IdToAdd, const string ServerNameToAdd)

Add a server to the server history list. Places the server at position 0; if the server already exists in the list elsewhere, it is moved to position 0.

Parameters:

• ControllerId - the index of the controller associated with the logged in player.
• IdToFind - the UniqueNetId for the server to add

AddServerPlusIP

function bool AddServerPlusIP (int ControllerID, OnlineSubsystem.UniqueNetId IDToAdd, string ServerNameToAdd, string IPToAdd)

FindServerIndexById

function int FindServerIndexById (int ControllerId, const out OnlineSubsystem.UniqueNetId IdToFind)

Find the index [into the server history list] of the specified server.

Parameters:

• ControllerId - the index of the controller associated with the logged in player.
• IdToFind - the UniqueNetId for the server to find

Returns:

the index [into the server history list] for the specified server

FindServerIndexByString

function int FindServerIndexByString (int ControllerId, string IdToFind)

Find the index [into the server history list] of the specified server.

Parameters:

• ControllerId - the index of the controller associated with the logged in player.
• IdToFind - the UniqueNetId for the server to find

Returns:

the index [into the server history list] for the specified server

GetPlayerName

function string GetPlayerName (optional int ControllerId)

Retrieve the name of the currently logged in profile.

Parameters:

• ControllerId - the index of the controller associated with the logged in player.

Returns:

the name of the currently logged in player.

GetPlayerNetId

function bool GetPlayerNetId (out OnlineSubsystem.UniqueNetId out_PlayerId, optional int ControllerId)

Retrieve the UniqueNetId for the currently logged in player.

Parameters:

• out_PlayerId - receives the value of the logged in player's UniqueNetId
• ControllerId - the index of the controller associated with the logged in player.

Returns:

TRUE if the logged in player's UniqueNetId was successfully retrieved.

GetServerIdList

function GetServerIdList (out array<OnlineSubsystem.UniqueNetId> out_ServerList)

Retrieve the list of most recently visited servers.

Parameters:

• out_ServerList - receives the list of UniqueNetIds for the most recently visited servers.

GetServerIP

function string GetServerIP (out const string IDString)

GetServerStringList

function GetServerStringList (out array<string> out_ServerList)

GetServerUID

function string GetServerUID (out const string IDString)

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.

OnSearchComplete

function OnSearchComplete (bool bWasSuccessful)

Overrides: UTDataStore_GameSearchBase.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

OverrideQuerySubmission

protected function bool OverrideQuerySubmission (byte ControllerId, OnlineGameSearch Search)

Overrides: UIDataStore_OnlineGameSearch.OverrideQuerySubmission

Worker for SubmitGameSeach; allows child classes to perform additional work before the query is submitted.

Parameters:

• ControllerId - the index of the controller for the player to perform the search for.
• Search - the search object that will be used to generate the query.

Returns:

TRUE to prevent SubmitGameSeach from submitting the search (such as when you do this step yourself).

RemoveServer

function bool RemoveServer (int ControllerId, OnlineSubsystem.UniqueNetId IdToRemove)

Removes the specified server from the server history list.

Parameters:

• ControllerId - the index of the controller associated with the logged in player.
• IdToRemove - the UniqueNetId for the server to remove