UE3:OnlineGameSettings (UT3)

Object >> Settings >> OnlineGameSettings

Package: 

Engine

Direct subclass:

UTGameSettingsCommon

This class in other games:

UDK

Holds the base configuration settings for an online game

Properties

AverageSkillRating

Type: float

Modifiers: databinding

The average of player skills currently playing in this game

Default value: 1000.0

bAllowInvites

Type: bool

Modifiers: databinding

Whether the match allows invitations for this session or not

Default value: True

bAllowJoinInProgress

Type: bool

Modifiers: databinding

Whether joining in progress is allowed or not

Default value: True

bAllowJoinViaPresence

Type: bool

Modifiers: databinding

Whether joining via player presence is allowed or not

Default value: True

bDebugRemoveOptionalSettings

Type: bool

Forces the removal of all optional settings (to test whether or not values are safe to remove)

bIsDedicated

Type: bool

Modifiers: databinding

Whether this server is a dedicated server or not

bIsLanMatch

Type: bool

Modifiers: databinding

This game will be lan only and not be visible to external players

bIsListPlay

Type: bool

Modifiers: databinding

Whether this server is a list play server or not

bShouldAdvertise

Type: bool

Modifiers: databinding

Whether this match is publicly advertised on the online service

Default value: True

bUsesArbitration

Type: bool

Modifiers: databinding

Whether the session should use arbitration or not

bUsesPresence

Type: bool

Modifiers: databinding

Whether to display user presence information or not

Default value: True

bUsesStats

Type: bool

Modifiers: databinding

Whether the match should gather stats or not

Default value: True

bWasFromInvite

Type: bool

Modifiers: const

Whether the game is an invitation or searched for game

DedicatedServerType

Type: EDedicatedServerType

The type of server based upon player service restrictions

EngineVersion

Type: int

Modifiers: databinding, const

The version of the engine the server is running

MaxSearchResults

Type: int

Max number of queries returned by the match finding service

MinNetVersion

Type: int

Modifiers: databinding, const

The minimum network version that is compatibile with the server

NumOpenPrivateConnections

Type: int

Modifiers: databinding

The number of private connections that are available (read only)

NumOpenPublicConnections

Type: int

Modifiers: databinding

The number of publicly available connections that are available (read only)

NumPrivateConnections

Type: int

Modifiers: databinding

The number of connections that are private (invite/password) only

NumPublicConnections

Type: int

Modifiers: databinding

The number of publicly available connections advertised

OptionalDataBindingSettings

Type: array<name>

Compared against the raw property name

OptionalLocalizedSettings

Type: array<int>

Compared against the localized settings 'ID' value

OptionalPropertySettings

Type: array<int>

Compared against the properties 'PropertyID' value

OwningPlayerId

Type: OnlineSubsystem.UniqueNetId

The unique net id of the player that owns this game

OwningPlayerName

Type: string

Modifiers: databinding

The owner of the game

PingInMs

Type: int

Modifiers: databinding

The ping of the server in milliseconds

Players

Type: array<PlayerRecord>

Players currently playing on the server

ServerIP

Type: string

Modifiers: databinding, const

The IP:Port of the server (set clientside when receiving server data)

ServerNonce

Type: byte

Array size: 8

Modifiers: const

The server's nonce for this session

Enums

EDedicatedServerType

The type of dedicated server (everyone, premium, etc)

DST_Standard 

Anyone that can play MP can join

DST_Premium1 

Anyone with a premium play account can join

DST_Premium2 

Anyone with the next level of premium play can join

Structs

PlayerRecord

Modifiers: native

string name 

The player name

int score 

The player's score

int ping 

The ping of the player as known by the server

string team 

the name of the team the player is on, or empty when there are no teams

int deaths 

number of times the player has died

int pid 

the player id in the current game

Events

TrimDataBindingValue

event bool TrimDataBindingValue (name PropertyName, int MaxLen, out string Value)

If a databinding setting wont fit into the server details results, give the script a chance to trim the data NOTE: Value will be in the format: ",Property=Value"

Parameters:

• PropertyName - The name of the property to be trimmed
• MaxLen - The maximum length of the string
• Value - The modified string value

Returns:

Whether or not the value was successfully trimmed

TrimLocalizedValue

event bool TrimLocalizedValue (int ID, int MaxLen, out string Value)

If a localized setting wont fit into the server details results, give the script a chance to trim the data NOTE: Value will be in the format: ",Property=Value"

Parameters:

• ID - The id of the localized value to be trimmed
• MaxLen - The maximum length of the string
• Value - The modified string value

Returns:

Whether or not the value was successfully trimmed

TrimPropertyValue

event bool TrimPropertyValue (int PropertyID, int MaxLen, out string Value)

If a property setting wont fit into the server details results, give the script a chance to trim the data NOTE: Value will be in the format: ",Property=Value"

Parameters:

• PropertyId - The id of the property setting to be trimmed
• MaxLen - The maximum length of the string
• Value - The modified string value

Returns:

Whether or not the value was successfully trimmed