I search for solutions in this order: Past Code, Unreal Source, Wiki, BUF, groups.yahoo, google, screaming at monitor. – RegularX

UE3:OnlineGameSearch (UDK)

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
UDK Object >> Settings >> OnlineGameSearch
Package: 
Engine
Direct subclass:
UTGameSearchCommon
This class in other games:
UT3

Holds the base settings for an online game search

Properties[edit]

AdditionalSearchCriteria[edit]

Type: string

String that is tacked onto the end of the search query (GameSpy only)

bIsLanQuery[edit]

Type: bool

Modifiers: databinding

Whether the query is intended for LAN matches or not

bIsSearchInProgress[edit]

Type: bool

Modifiers: const

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

bUsesArbitration[edit]

Type: bool

Modifiers: databinding

Whether to use arbitration or not

FilterQuery[edit]

Type: OnlineGameSearchQuery

Modifiers: const

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

GameSettingsClass[edit]

Type: class<OnlineGameSettings>

The class to create for each returned result from the search

Default value: Class'Engine.OnlineGameSettings'

ManualSkillOverride[edit]

Type: OverrideSkill

Instance of the above to manually specify the players involved in the skill search

MaxSearchResults[edit]

Type: int

Max number of queries returned by the matchmaking service

Default value: 25

NamedProperties[edit]

Type: array<NamedObjectProperty>

The list of named properties to search on

PingBucketSize[edit]

Type: int

Used to sort games into buckets since a the difference in terms of feel for ping in the same bucket is often not a useful comparison and skill is better

Default value: 50

Query[edit]

Type: Settings.LocalizedStringSetting

The query to use for finding matching servers

Results[edit]

Type: array<OnlineGameSearchResult>

Modifiers: const

The list of servers and their settings that match the search

Enums[edit]

EOnlineGameSearchComparisonType[edit]

The type of comparison to perform on the search entry

OGSCT_Equals 
OGSCT_NotEquals 
OGSCT_GreaterThan 
OGSCT_GreaterThanEquals 
OGSCT_LessThan 
OGSCT_LessThanEquals 

EOnlineGameSearchEntryType[edit]

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

OGSET_Property 
A property is used to filter with
OGSET_LocalizedSetting 
A localized setting is used to filter with
OGSET_ObjectProperty 
A property on the game settings object to filter with

EOnlineGameSearchSortType[edit]

Used to indicate which way to sort a result set

OGSSO_Ascending 
OGSSO_Descending 

Structs[edit]

NamedObjectProperty[edit]

Modifiers: native

Used to search for named properties on game setting objects

name ObjectPropertyName 
The name of the property to search with
string ObjectPropertyValue 
The string value to compare against

OnlineGameSearchORClause[edit]

Modifiers: native

Matches parameters using a series of OR comparisons

array<OnlineGameSearchParameter> OrParams 
The list of parameters to compare and use as an OR clause

OnlineGameSearchParameter[edit]

Modifiers: native

Struct used to describe a search criteria

int EntryId 
The Id of the property or localized string
name ObjectPropertyName 
The name of the property to search with
EOnlineGameSearchEntryType EntryType 
Whether this parameter to compare against comes from a property or a localized setting
EOnlineGameSearchComparisonType ComparisonType 
The type of comparison to perform

OnlineGameSearchQuery[edit]

Modifiers: native

Struct used to describe a query

array<OnlineGameSearchORClause> OrClauses 
A set of OR clauses that are ANDed together to filter potential servers
array<OnlineGameSearchSortClause> SortClauses 
A list of sort operations used to order the servers that match the filtering

OnlineGameSearchResult[edit]

Modifiers: native

Struct used to return matching servers

OnlineGameSettings GameSettings 
The settings used by this particular server
pointer{void} 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!

OnlineGameSearchSortClause[edit]

Modifiers: native

Struct used to describe the sorting of items

int EntryId 
The Id of the property or localized string
name ObjectPropertyName 
The name of the property to search with
EOnlineGameSearchEntryType EntryType 
Whether this parameter to compare against comes from a property or a localized setting
EOnlineGameSearchSortType SortType 
The type of comparison to perform

OverrideSkill[edit]

Modifiers: native

Used to manually specify the skill to use when matchmaking

int LeaderboardId 
The skill leaderboard to read the player skill from
array<OnlineSubsystem.UniqueNetId> Players 
The set of players to read the skill for
array<Object.double> Mus 
The set of skill values to use
array<Object.double> Sigmas 

Functions[edit]

Native functions[edit]

SortSearchResults[edit]

native event SortSearchResults ()

Allows a search object to provide a customized sort routine to order the results in a way that best fits the game type

Other instance functions[edit]

SetSkillOverride[edit]

function SetSkillOverride (int LeaderboardId, const out array<OnlineSubsystem.UniqueNetIdPlayers)

Sets the information needed to do a manual specification of the skill to use when searching

Parameters:

  • LeaderboardId - the skill leaderboard to read from
  • Players - the set of players to use when determining the skill