Once I get that upgrade to 36-hour days, I will tackle that. – Mychaeel

Difference between revisions of "UE3:OnlineGameSearch (UT3)"

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
(Auto-generated page)
 
m (added missing members)
 
Line 19: Line 19:
  
 
Whether the search object in question has a dedicated server search in progress or not
 
Whether the search object in question has a dedicated server search in progress or not
 +
 +
====bIsFullServerUpdate====
 +
'''Type:''' [[bool]]
 +
 +
'''[[Variables#Modifiers|Modifiers]]:''' const
 +
 +
Whether or not this is a full server refresh (as compared to just a single server update)
  
 
====bIsLanQuery====
 
====bIsLanQuery====
Line 77: Line 84:
  
 
Whether to use arbitration or not
 
Whether to use arbitration or not
 +
 +
====ClientsideFilters====
 +
'''Type:''' [[array]]<{{tl|ClientOnlineGameSearchOrClause}}>
 +
 +
A list of clientside filters which are ANDed together
  
 
====FilterQuery====
 
====FilterQuery====
Line 115: Line 127:
  
 
The query to use for finding matching servers
 
The query to use for finding matching servers
 +
 +
====RawFilterQueries====
 +
'''Type:''' [[array]]<{{tl|RawOnlineGameSearchOrClause}}>
 +
 +
A list of additional manually defined queries which are ANDed together
 +
 +
====RemainingFilterQueries====
 +
'''Type:''' [[array]]<{{tl|RawOnlineGameSearchOrClause}}>
 +
 +
'''[[Variables#Modifiers|Modifiers]]:''' const
 +
 +
If 'FilterQuery'+'RawFilterQueries' exceeds Gamespy's query limit (512 bytes), the excess queries from 'RawFilterQueries' are put here for clientside filtering
  
 
====Results====
 
====Results====
Line 122: Line 146:
  
 
The list of servers and their settings that match the search
 
The list of servers and their settings that match the search
 +
 +
====SearchHandle====
 +
'''Type:''' [[pointer]]''{void}''
 +
 +
'''[[Variables#Modifiers|Modifiers]]:''' native, const, transient, private
 +
 +
Platform specific data related to the game search
  
 
==Enums==
 
==Enums==
Line 145: Line 176:
  
 
==Structs==
 
==Structs==
 +
===ClientOnlineGameSearchOrClause===
 +
'''[[Structs#Modifiers|Modifiers]]:''' native
 +
 +
Matches parameters using a series of OR comparisions
 +
; [[array]]<{{tl|ClientOnlineGameSearchParameter}}> OrParams : The list of parameters to compare and use as an OR clause
 +
 +
===ClientOnlineGameSearchParameter===
 +
'''Extends:''' {{tl|RawOnlineGameSearchParameterTemplate}}
 +
 +
'''[[Structs#Modifiers|Modifiers]]:''' native
 +
 +
Struct used to define a clientside filter, which is based upon the 'raw' game search parameter
 +
; [[delegate]]<{{tl|OnComparePropertyValue}}> ComparisonDelegate : The delegate which is used to compare the parameter values, this must be set when adding to 'ClientsideFilters'
 +
 
===NamedObjectProperty===
 
===NamedObjectProperty===
 
'''[[Structs#Modifiers|Modifiers]]:''' native
 
'''[[Structs#Modifiers|Modifiers]]:''' native
Line 182: Line 227:
 
NOTE: It is imperative that the subsystem be called to clean this data
 
NOTE: It is imperative that the subsystem be called to clean this data
 
up or the PlatformData will leak memory!
 
up or the PlatformData will leak memory!
 +
; [[pointer]]''{void}'' ServerSearchData : Platform/online provider specific data
  
 
===OnlineGameSearchSortClause===
 
===OnlineGameSearchSortClause===
Line 191: Line 237:
 
; {{tl|EOnlineGameSearchEntryType}} EntryType : Whether this parameter to compare against comes from a property or a localized setting
 
; {{tl|EOnlineGameSearchEntryType}} EntryType : Whether this parameter to compare against comes from a property or a localized setting
 
; {{tl|EOnlineGameSearchSortType}} SortType : The type of comparison to perform
 
; {{tl|EOnlineGameSearchSortType}} SortType : The type of comparison to perform
 +
 +
===RawOnlineGameSearchOrClause===
 +
'''[[Structs#Modifiers|Modifiers]]:''' native
 +
 +
Matches raw parameters using a series of OR comparisons
 +
; [[array]]<{{tl|RawOnlineGameSearchParameter}}> OrParams : The list of raw parameters to compare and use as an OR clause
 +
 +
===RawOnlineGameSearchParameter===
 +
'''Extends:''' {{tl|RawOnlineGameSearchParameterTemplate}}
 +
 +
'''[[Structs#Modifiers|Modifiers]]:''' native
 +
 +
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)
 +
; [[string]] ComparisonOperator : NOTE: For the LIKE and NOT LIKE operators, you will need to add a space at the start of this string
 +
 +
===RawOnlineGameSearchParameterTemplate===
 +
'''[[Structs#Modifiers|Modifiers]]:''' native
 +
 +
Template struct used to define a search parameter with manually defined comparision operator and value fields
 +
; [[int]] EntryId : The Id of the property or localized string to be compared
 +
; [[name]] ObjectPropertyName : The name of the property to search with
 +
; {{tl|EOnlineGameSearchEntryType}} EntryType : Whether this parameter to compare against comes from a property or a localized setting
 +
; [[string]] EntryValue : If set, this string overrides the above variables, and will represent the server property that will be compared
 +
; [[string]] ComparedValue : The value to be compared against (N.B. For string comparisons, % is a wildcard, e.g. '%test%')
 +
 +
==Delegates==
 +
====OnComparePropertyValue====
 +
{{code|delegate [[bool]]&nbsp;'''OnComparePropertyValue''' ([[string]]&nbsp;'''PropertyValue''', [[string]]&nbsp;'''ComparedValue''')}}
 +
 +
Delegate template for comparing game search parameter values
 +
 +
==Instance functions==
 +
====ResetFilters====
 +
{{code|function '''ResetFilters''' ()}}
 +
 +
<!-- enter function description -->

Latest revision as of 02:10, 16 August 2009

UT3 Object >> Settings >> OnlineGameSearch
Package: 
Engine
Direct subclass:
UTGameSearchCommon
This class in other games:
UDK
This is an auto-generated page and may need human attention.
Please remove the {{autogenerated}} tag if the page seems reasonably complete or replace it with the {{expand}} tag if the page is not yet complete.

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

bIsDedicatedServerSearchInProgress[edit]

Type: bool

Modifiers: const

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

bIsFullServerUpdate[edit]

Type: bool

Modifiers: const

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

bIsLanQuery[edit]

Type: bool

Modifiers: databinding

Whether the query is intended for LAN matches or not

bIsListenServerSearchInProgress[edit]

Type: bool

Modifiers: const

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

bIsListPlaySearchInProgress[edit]

Type: bool

Modifiers: const

Whether the search object in question has a list play search in progress 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

bShouldIncludeDedicatedServers[edit]

Type: bool

Modifiers: databinding

Whether the search should include dedicated servers or not

bShouldIncludeListenServers[edit]

Type: bool

Modifiers: databinding

Whether the search should include listen servers or not

Default value: True

bShouldIncludeListPlayServers[edit]

Type: bool

Modifiers: databinding

Whether the search should include list play servers or not

bUsesArbitration[edit]

Type: bool

Modifiers: databinding

Whether to use arbitration or not

ClientsideFilters[edit]

Type: array<ClientOnlineGameSearchOrClause>

A list of clientside filters which are ANDed together

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'

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

NumListPlayServersAvailable[edit]

Type: int

Modifiers: databinding

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

Query[edit]

Type: Settings.LocalizedStringSetting

The query to use for finding matching servers

RawFilterQueries[edit]

Type: array<RawOnlineGameSearchOrClause>

A list of additional manually defined queries which are ANDed together

RemainingFilterQueries[edit]

Type: array<RawOnlineGameSearchOrClause>

Modifiers: const

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

Results[edit]

Type: array<OnlineGameSearchResult>

Modifiers: const

The list of servers and their settings that match the search

SearchHandle[edit]

Type: pointer{void}

Modifiers: native, const, transient, private

Platform specific data related to the game 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]

ClientOnlineGameSearchOrClause[edit]

Modifiers: native

Matches parameters using a series of OR comparisions

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

ClientOnlineGameSearchParameter[edit]

Extends: RawOnlineGameSearchParameterTemplate

Modifiers: native

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

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

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!

pointer{void} ServerSearchData 
Platform/online provider specific data

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

RawOnlineGameSearchOrClause[edit]

Modifiers: native

Matches raw parameters using a series of OR comparisons

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

RawOnlineGameSearchParameter[edit]

Extends: RawOnlineGameSearchParameterTemplate

Modifiers: native

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)

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

RawOnlineGameSearchParameterTemplate[edit]

Modifiers: native

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

int EntryId 
The Id of the property or localized string to be compared
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
string EntryValue 
If set, this string overrides the above variables, and will represent the server property that will be compared
string ComparedValue 
The value to be compared against (N.B. For string comparisons, % is a wildcard, e.g. '%test%')

Delegates[edit]

OnComparePropertyValue[edit]

delegate bool OnComparePropertyValue (string PropertyValue, string ComparedValue)

Delegate template for comparing game search parameter values

Instance functions[edit]

ResetFilters[edit]

function ResetFilters ()


Retrieved from "https://wiki.beyondunreal.com/UE3:OnlineGameSearch_(UT3)?oldid=35056"