Engine.OnlineGameSearch

Extends

Settings

Modifiers

native

Holds the base settings for an online game search

Core.Object
|   
+-- Engine.Settings
   |   
   +-- Engine.OnlineGameSearch

Direct Known Subclasses:

UTGameSearchCommon

Delegates Summary
	bool	OnComparePropertyValue (string PropertyValue, string ComparedValue))

Functions Summary
		ResetFilters ()))

AdditionalSearchCriteria Source code

String that is tacked onto the end of the search query

bIsDedicatedServerSearchInProgress Source code

Whether the search object in question has a dedicated server search in progress or not

bIsFullServerUpdate Source code

Whether or not this is a full server refresh (as compared to just a single server update)

bIsLanQuery Source code

Whether the query is intended for LAN matches or not

bIsListenServerSearchInProgress Source code

Whether the search object in question has a listen server search in progress or not

bIsListPlaySearchInProgress Source code

Whether the search object in question has a list play search in progress or not

bIsSearchInProgress Source code

Whether the search object in question is in progress or not. This is the union of the other flags

bShouldIncludeDedicatedServers Source code

Whether the search should include dedicated servers or not

bShouldIncludeListenServers Source code

Whether the search should include listen servers or not

bShouldIncludeListPlayServers Source code

Whether the search should include list play servers or not

bUsesArbitration Source code

Whether to use arbitration or not

ClientsideFilters Source code

A list of clientside filters which are ANDed together

FilterQuery Source code

Holds the query to use when filtering servers and they require non-predefined queries

GameSettingsClass Source code

The class to create for each returned result from the search

MaxSearchResults Source code

Max number of queries returned by the matchmaking service

NamedProperties Source code

The list of named properties to search on

NumListPlayServersAvailable Source code

The total number of list play servers available if a list play search

Query Source code

The query to use for finding matching servers

RawFilterQueries Source code

A list of additional manually defined queries which are ANDed together

RemainingFilterQueries Source code

If 'FilterQuery'+'RawFilterQueries' exceeds Gamespy's query limit (512 bytes), the excess queries from 'RawFilterQueries' are put here for clientside filtering

Results Source code

The list of servers and their settings that match the search

SearchHandle Source code

Platform specific data related to the game search

EOnlineGameSearchComparisonType Source code

The type of comparison to perform on the search entry

EOnlineGameSearchEntryType Source code

The type of data to use to fill out an online parameter

EOnlineGameSearchSortType Source code

Used to indicate which way to sort a result set

ClientOnlineGameSearchOrClause Source code

Matches parameters using a series of OR comparisions
OrParams:

The list of parameters to compare and use as an OR clause

ClientOnlineGameSearchParameter Source code

Struct used to define a clientside filter, which is based upon the 'raw' game search parameter
ComparisonDelegate:

The delegate which is used to compare the parameter values, this must be set when adding to 'ClientsideFilters'

NamedObjectProperty Source code

Used to search for named properties on game setting objects
ObjectPropertyName:

The name of the property to search with

ObjectPropertyValue:

The string value to compare against

OnlineGameSearchORClause Source code

Matches parameters using a series of OR comparisons
OrParams:

The list of parameters to compare and use as an OR clause

OnlineGameSearchParameter Source code

Struct used to describe a search criteria
ComparisonType:

The type of comparison to perform

EntryId:

The Id of the property or localized string

EntryType:

Whether this parameter to compare against comes from a property or a localized setting

ObjectPropertyName:

The name of the property to search with

OnlineGameSearchQuery Source code

Struct used to describe a query
OrClauses:

A set of OR clauses that are ANDed together to filter potential servers

SortClauses:

A list of sort operations used to order the servers that match the filtering

OnlineGameSearchResult Source code

Struct used to return matching servers
GameSettings:

The settings used by this particular server

PlatformData:

Platform/online provider specific data NOTE: It is imperative that the subsystem be called to clean this data up or the PlatformData will leak memory!

ServerSearchData:

Platform/online provider specific data

OnlineGameSearchSortClause Source code

Struct used to describe the sorting of items
EntryId:

The Id of the property or localized string

EntryType:

Whether this parameter to compare against comes from a property or a localized setting

ObjectPropertyName:

The name of the property to search with

SortType:

The type of comparison to perform

RawOnlineGameSearchOrClause Source code

Matches raw parameters using a series of OR comparisons
OrParams:

The list of raw parameters to compare and use as an OR clause

RawOnlineGameSearchParameter Source code

Struct used to define a 'raw' game search parameter, which is sent to the Gamespy master server (or evaluated clientside, if the query limit is reached)
ComparisonOperator:

NOTE: For the LIKE and NOT LIKE operators, you will need to add a space at the start of this string

RawOnlineGameSearchParameterTemplate Source code

Template struct used to define a search parameter with manually defined comparision operator and value fields
ComparedValue:

The value to be compared against (N.B. For string comparisons, % is a wildcard, e.g. '%test%')

EntryId:

The Id of the property or localized string to be compared

EntryType:

Whether this parameter to compare against comes from a property or a localized setting

EntryValue:

If set, this string overrides the above variables, and will represent the server property that will be compared

ObjectPropertyName:

The name of the property to search with

OnComparePropertyValue Source code

Delegate template for comparing game search parameter values

ResetFilters Source code

defaultproperties
{
   MaxSearchResults=25
   bShouldIncludeListenServers=True
   GameSettingsClass=Class'Engine.OnlineGameSettings'
   Name="Default__OnlineGameSearch"
   ObjectArchetype=Settings'Engine.Default__Settings'
}