Overview Package Class Source Class tree Glossary
previous class      next class frames      no frames

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

Constants Summary
Inherited Contants from Core.Object
DegToRad, INDEX_NONE, MaxInt, Pi, RadToDeg

Variables Summary
stringAdditionalSearchCriteria
boolbIsDedicatedServerSearchInProgress
boolbIsLanQuery
boolbIsListenServerSearchInProgress
boolbIsListPlaySearchInProgress
boolbIsSearchInProgress
boolbShouldIncludeDedicatedServers
boolbShouldIncludeListenServers
boolbShouldIncludeListPlayServers
boolbUsesArbitration
OnlineGameSearchQueryFilterQuery
class<OnlineGameSettings>GameSettingsClass
intMaxSearchResults
array<NamedObjectProperty>NamedProperties
intNumListPlayServersAvailable
LocalizedStringSettingQuery
array<OnlineGameSearchResult>Results
Inherited Variables from Engine.Settings
LocalizedSettings, LocalizedSettingsMappings, Properties, PropertyMappings
Inherited Variables from Core.Object
Class, HashNext, HashOuterNext, Linker, LinkerIndex, Name, NetIndex, ObjectArchetype, ObjectFlags, ObjectInternalInteger, Outer, StateFrame, VfTableObject

Enumerations Summary
EOnlineGameSearchComparisonType
OGSCT_Equals, OGSCT_NotEquals, OGSCT_GreaterThan, OGSCT_GreaterThanEquals, OGSCT_LessThan, OGSCT_LessThanEquals
EOnlineGameSearchEntryType
OGSET_Property, OGSET_LocalizedSetting, OGSET_ObjectProperty
EOnlineGameSearchSortType
OGSSO_Ascending, OGSSO_Descending
Inherited Enumerations from Engine.Settings
EOnlineDataAdvertisementType, EPropertyValueMappingType, ESettingsDataType
Inherited Enumerations from Core.Object
EAxis, EInputEvent, EInterpCurveMode, EInterpMethodType, ETickingGroup

Structures Summary
NamedObjectProperty
ObjectPropertyName, ObjectPropertyValue
OnlineGameSearchORClause
OrParams
OnlineGameSearchParameter
EntryId, ObjectPropertyName, EntryType, ComparisonType
OnlineGameSearchQuery
OrClauses, SortClauses
OnlineGameSearchResult
GameSettings, PlatformData
OnlineGameSearchSortClause
EntryId, ObjectPropertyName, EntryType, SortType
Inherited Structures from Engine.Settings
IdToStringMapping, LocalizedStringSetting, LocalizedStringSettingMetaData, SettingsData, SettingsProperty, SettingsPropertyPropertyMetaData, StringIdToStringMapping
Inherited Structures from Core.Object
Box, BoxSphereBounds, Color, Cylinder, double, DynamicMap_Mirror, Guid, IndirectArray_Mirror, InterpCurveFloat, InterpCurvePointFloat, InterpCurvePointQuat, InterpCurvePointTwoVectors, InterpCurvePointVector, InterpCurvePointVector2D, InterpCurveQuat, InterpCurveTwoVectors, InterpCurveVector, InterpCurveVector2D, IntPoint, LinearColor, Map_Mirror, Matrix, MultiMap_Mirror, Plane, pointer, Quat, qword, RawDistribution, RenderCommandFence, Rotator, TextureMipBulkData_Mirror, ThreadSafeCounter, TPOV, TwoVectors, UntypedBulkData_Mirror, Vector, Vector2D, Vector4

Functions Summary
Inherited Functions from Engine.Settings
AppendContextsToURL, AppendDataBindingsToURL, AppendPropertiesToURL, BuildURL, EmptySettingsData, GetFloatProperty, GetIntProperty, GetPropertyAsString, GetPropertyAsStringByName, GetPropertyColumnHeader, GetPropertyId, GetPropertyMappingType, GetPropertyName, GetPropertyRange, GetPropertyType, GetQoSAdvertisedProperties, GetQoSAdvertisedStringSettings, GetRangedPropertyValue, GetSettingsDataBlob, GetSettingsDataDateTime, GetSettingsDataFloat, GetSettingsDataInt, GetSettingsDataString, GetStringProperty, GetStringSettingColumnHeader, GetStringSettingId, GetStringSettingName, GetStringSettingValue, GetStringSettingValueByName, GetStringSettingValueName, GetStringSettingValueNameByName, GetStringSettingValueNames, HasProperty, HasStringSetting, IsWildcardStringSetting, SetFloatProperty, SetIntProperty, SetPropertyFromStringByName, SetRangedPropertyValue, SetSettingsData, SetSettingsDataBlob, SetSettingsDataDateTime, SetSettingsDataFloat, SetSettingsDataInt, SetSettingsDataString, SetStringProperty, SetStringSettingValue, SetStringSettingValueByName, SetStringSettingValueFromStringByName, UpdateFromURL, UpdateProperties, UpdateStringSettings
Inherited Functions from Core.Object
!, !=, $, $=, %, &, &&, *, **, *=, +, ++, +=, -, --, -=, / , /=, <, <<, <=, ==, >, >=, >>, >>>, @, @=, Abs, Acos, Asc, Asin, Atan, BeginState, ByteToFloat, Caps, Chr, Clamp, ClampLength, ClampRotAxis, ClassIsChildOf, ClockwiseFrom, ColorToLinearColor, ContinuedState, Cos, Cross, Disable, Dot, DumpStateStack, DynamicLoadObject, Enable, EndState, Exp, FClamp, FCubicInterp, FindDeltaAngle, FindObject, FInterpEaseIn, FInterpEaseInOut, FInterpEaseOut, FInterpTo, FloatToByte, FMax, FMin, FPctByRange, FRand, GetAngularDegreesFromRadians, GetAngularDistance, GetAngularFromDotDist, GetAxes, GetDotDistance, GetEnum, GetFuncName, GetHeadingAngle, GetPackageName, GetPerObjectConfigSections, GetRangePctByValue, GetRangeValueByPct, GetSpecialValue, GetStateName, GetUnAxes, GotoState, InStr, IsA, IsChildState, IsInState, IsPendingKill, IsUTracing, IsZero, JoinArray, Left, Len, Lerp, Localize, Locs, Loge, LogInternal, MakeColor, MakeLinearColor, Max, Mid, Min, MirrorVectorByNormal, Normal, Normalize, NormalizeRotAxis, OrthoRotation, ParseStringIntoArray, PathName, PausedState, PointDistToLine, PointDistToPlane, PointInBox, PoppedState, PopState, ProjectOnTo, PushedState, PushState, QuatDot, QuatFindBetween, QuatFromAxisAndAngle, QuatFromRotator, QuatInvert, QuatProduct, QuatRotateVector, QuatSlerp, QuatToRotator, Rand, RandRange, RDiff, Repl, Right, RInterpTo, RLerp, RotRand, Round, RSize, RSmerp, SaveConfig, SClampRotAxis, ScriptTrace, SetSpecialValue, SetUTracing, Sin, Split, Sqrt, Square, StaticSaveConfig, Tan, ToHex, TransformVectorByRotation, UnwindHeading, vect2d, VInterpTo, VLerp, VRand, VSize, VSize2D, VSizeSq, VSizeSq2D, VSmerp, WarnInternal, ^, ^^, |, ||, ~, ~=


Variables Detail

AdditionalSearchCriteria Source code

var string AdditionalSearchCriteria;
String that is tacked onto the end of the search query

bIsDedicatedServerSearchInProgress Source code

var const bool bIsDedicatedServerSearchInProgress;
Whether the search object in question has a dedicated server search in progress or not

bIsLanQuery Source code

var databinding bool bIsLanQuery;
Whether the query is intended for LAN matches or not

bIsListenServerSearchInProgress Source code

var const bool bIsListenServerSearchInProgress;
Whether the search object in question has a listen server search in progress or not

bIsListPlaySearchInProgress Source code

var const bool bIsListPlaySearchInProgress;
Whether the search object in question has a list play search in progress or not

bIsSearchInProgress Source code

var const bool bIsSearchInProgress;
Whether the search object in question is in progress or not. This is the union of the other flags

bShouldIncludeDedicatedServers Source code

var databinding bool bShouldIncludeDedicatedServers;
Whether the search should include dedicated servers or not

bShouldIncludeListenServers Source code

var databinding bool bShouldIncludeListenServers;
Whether the search should include listen servers or not

bShouldIncludeListPlayServers Source code

var databinding bool bShouldIncludeListPlayServers;
Whether the search should include list play servers or not

bUsesArbitration Source code

var databinding bool bUsesArbitration;
Whether to use arbitration or not

FilterQuery Source code

var const OnlineGameSearchQuery FilterQuery;
Holds the query to use when filtering servers and they require non-predefined queries

GameSettingsClass Source code

var class<OnlineGameSettings> GameSettingsClass;
The class to create for each returned result from the search

MaxSearchResults Source code

var int MaxSearchResults;
Max number of queries returned by the matchmaking service

NamedProperties Source code

var array<NamedObjectProperty> NamedProperties;
The list of named properties to search on

NumListPlayServersAvailable Source code

var databinding int NumListPlayServersAvailable;
The total number of list play servers available if a list play search

Query Source code

var LocalizedStringSetting Query;
The query to use for finding matching servers

Results Source code

var const array<OnlineGameSearchResult> Results;
The list of servers and their settings that match the search


Enumerations Detail

EOnlineGameSearchComparisonType Source code

enum EOnlineGameSearchComparisonType
{
OGSCT_Equals, OGSCT_NotEquals, OGSCT_GreaterThan, OGSCT_GreaterThanEquals, OGSCT_LessThan, OGSCT_LessThanEquals
};
The type of comparison to perform on the search entry

EOnlineGameSearchEntryType Source code

enum EOnlineGameSearchEntryType
{
OGSET_Property, OGSET_LocalizedSetting, OGSET_ObjectProperty
};
The type of data to use to fill out an online parameter

EOnlineGameSearchSortType Source code

enum EOnlineGameSearchSortType
{
OGSSO_Ascending, OGSSO_Descending
};
Used to indicate which way to sort a result set


Structures Detail

NamedObjectProperty Source code

struct NamedObjectProperty
{
var name ObjectPropertyName;
var string ObjectPropertyValue;
};
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

struct OnlineGameSearchORClause
{
var array<OnlineGameSearchParameter> OrParams;
};
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 OnlineGameSearchParameter
{
var EOnlineGameSearchComparisonType ComparisonType;
var int EntryId;
var EOnlineGameSearchEntryType EntryType;
var name ObjectPropertyName;
};
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 OnlineGameSearchQuery
{
var array<OnlineGameSearchORClause> OrClauses;
var array<OnlineGameSearchSortClause> SortClauses;
};
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 OnlineGameSearchResult
{
var const OnlineGameSettings GameSettings;
var const native pointer PlatformData;
};
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!

OnlineGameSearchSortClause Source code

struct OnlineGameSearchSortClause
{
var int EntryId;
var EOnlineGameSearchEntryType EntryType;
var name ObjectPropertyName;
var EOnlineGameSearchSortType SortType;
};
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


Defaultproperties

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

Overview Package Class Source Class tree Glossary
previous class      next class frames      no frames
Creation time: Mon 26/11/2007 17:41:02.218 - Created with UnCodeX