Engine.OnlineGameSettings

Extends

Settings

Modifiers

native

Holds the base configuration settings for an online game

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

Direct Known Subclasses:

UTGameSettingsCommon

Functions Summary
	bool	TrimDataBindingValue (name PropertyName, int MaxLen, out string Value))
	bool	TrimLocalizedValue (int ID, int MaxLen, out string Value))
	bool	TrimPropertyValue (int PropertyID, int MaxLen, out string Value))

AverageSkillRating Source code

The average of player skills currently playing in this game

bAllowInvites Source code

Whether the match allows invitations for this session or not

bAllowJoinInProgress Source code

Whether joining in progress is allowed or not

bAllowJoinViaPresence Source code

Whether joining via player presence is allowed or not

bDebugRemoveOptionalSettings Source code

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

bIsDedicated Source code

Whether this server is a dedicated server or not

bIsLanMatch Source code

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

bIsListPlay Source code

Whether this server is a list play server or not

bShouldAdvertise Source code

Whether this match is publicly advertised on the online service

bUsesArbitration Source code

Whether the session should use arbitration or not

bUsesPresence Source code

Whether to display user presence information or not

bUsesStats Source code

Whether the match should gather stats or not

bWasFromInvite Source code

Whether the game is an invitation or searched for game

DedicatedServerType Source code

The type of server based upon player service restrictions

EngineVersion Source code

The version of the engine the server is running

MaxSearchResults Source code

Max number of queries returned by the match finding service

MinNetVersion Source code

The minimum network version that is compatibile with the server

NumOpenPrivateConnections Source code

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

NumOpenPublicConnections Source code

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

NumPrivateConnections Source code

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

NumPublicConnections Source code

The number of publicly available connections advertised

OptionalDataBindingSettings Source code

Compared against the raw property name

OptionalLocalizedSettings Source code

Compared against the localized settings 'ID' value

OptionalPropertySettings Source code

Compared against the properties 'PropertyID' value

OwningPlayerId Source code

The unique net id of the player that owns this game

OwningPlayerName Source code

The owner of the game

PingInMs Source code

The ping of the server in milliseconds

Players Source code

Players currently playing on the server

ServerIP Source code

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

ServerNonce[8] Source code

The server's nonce for this session

EDedicatedServerType Source code

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

PlayerRecord Source code

deaths:

number of times the player has died

name:

The player name

pid:

the player id in the current game

ping:

The ping of the player as known by the server

score:

The player's score

team:

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

TrimDataBindingValue Source code

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"
@param PropertyName The name of the property to be trimmed
@param MaxLen The maximum length of the string
@param Value The modified string value
@return Whether or not the value was successfully trimmed

TrimLocalizedValue Source code

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"
@param ID The id of the localized value to be trimmed
@param MaxLen The maximum length of the string
@param Value The modified string value
@return Whether or not the value was successfully trimmed

TrimPropertyValue Source code

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"
@param PropertyId The id of the property setting to be trimmed
@param MaxLen The maximum length of the string
@param Value The modified string value
@return Whether or not the value was successfully trimmed

defaultproperties
{
   bShouldAdvertise=True
   bUsesStats=True
   bAllowJoinInProgress=True
   bAllowInvites=True
   bUsesPresence=True
   bAllowJoinViaPresence=True
   AverageSkillRating=1000.000000
   Name="Default__OnlineGameSettings"
   ObjectArchetype=Settings'Engine.Default__Settings'
}