Mostly Harmless
UE3:OnlineGameSettings (UT3)
Contents
- 1 Properties
- 1.1 AverageSkillRating
- 1.2 bAllowInvites
- 1.3 bAllowJoinInProgress
- 1.4 bAllowJoinViaPresence
- 1.5 bDebugRemoveOptionalSettings
- 1.6 bIsDedicated
- 1.7 bIsLanMatch
- 1.8 bIsListPlay
- 1.9 bShouldAdvertise
- 1.10 bUsesArbitration
- 1.11 bUsesPresence
- 1.12 bUsesStats
- 1.13 bWasFromInvite
- 1.14 DedicatedServerType
- 1.15 EngineVersion
- 1.16 MaxSearchResults
- 1.17 MinNetVersion
- 1.18 NumOpenPrivateConnections
- 1.19 NumOpenPublicConnections
- 1.20 NumPrivateConnections
- 1.21 NumPublicConnections
- 1.22 OptionalDataBindingSettings
- 1.23 OptionalLocalizedSettings
- 1.24 OptionalPropertySettings
- 1.25 OwningPlayerId
- 1.26 OwningPlayerName
- 1.27 PingInMs
- 1.28 Players
- 1.29 ServerIP
- 1.30 ServerNonce
- 2 Enums
- 3 Structs
- 4 Events
- Package:
- Engine
- Direct subclass:
- UTGameSettingsCommon
- 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 configuration settings for an online game
Properties[edit]
AverageSkillRating[edit]
Type: float
Modifiers: databinding
The average of player skills currently playing in this game
Default value: 1000.0
bAllowInvites[edit]
Type: bool
Modifiers: databinding
Whether the match allows invitations for this session or not
Default value: True
bAllowJoinInProgress[edit]
Type: bool
Modifiers: databinding
Whether joining in progress is allowed or not
Default value: True
bAllowJoinViaPresence[edit]
Type: bool
Modifiers: databinding
Whether joining via player presence is allowed or not
Default value: True
bDebugRemoveOptionalSettings[edit]
Type: bool
Forces the removal of all optional settings (to test whether or not values are safe to remove)
bIsDedicated[edit]
Type: bool
Modifiers: databinding
Whether this server is a dedicated server or not
bIsLanMatch[edit]
Type: bool
Modifiers: databinding
This game will be lan only and not be visible to external players
bIsListPlay[edit]
Type: bool
Modifiers: databinding
Whether this server is a list play server or not
bShouldAdvertise[edit]
Type: bool
Modifiers: databinding
Whether this match is publicly advertised on the online service
Default value: True
bUsesArbitration[edit]
Type: bool
Modifiers: databinding
Whether the session should use arbitration or not
bUsesPresence[edit]
Type: bool
Modifiers: databinding
Whether to display user presence information or not
Default value: True
bUsesStats[edit]
Type: bool
Modifiers: databinding
Whether the match should gather stats or not
Default value: True
bWasFromInvite[edit]
Type: bool
Modifiers: const
Whether the game is an invitation or searched for game
DedicatedServerType[edit]
Type: EDedicatedServerType
The type of server based upon player service restrictions
EngineVersion[edit]
Type: int
Modifiers: databinding, const
The version of the engine the server is running
MaxSearchResults[edit]
Type: int
Max number of queries returned by the match finding service
MinNetVersion[edit]
Type: int
Modifiers: databinding, const
The minimum network version that is compatibile with the server
NumOpenPrivateConnections[edit]
Type: int
Modifiers: databinding
The number of private connections that are available (read only)
NumOpenPublicConnections[edit]
Type: int
Modifiers: databinding
The number of publicly available connections that are available (read only)
NumPrivateConnections[edit]
Type: int
Modifiers: databinding
The number of connections that are private (invite/password) only
NumPublicConnections[edit]
Type: int
Modifiers: databinding
The number of publicly available connections advertised
OptionalDataBindingSettings[edit]
Compared against the raw property name
OptionalLocalizedSettings[edit]
Compared against the localized settings 'ID' value
OptionalPropertySettings[edit]
Compared against the properties 'PropertyID' value
OwningPlayerId[edit]
Type: OnlineSubsystem.UniqueNetId
The unique net id of the player that owns this game
OwningPlayerName[edit]
Type: string
Modifiers: databinding
The owner of the game
PingInMs[edit]
Type: int
Modifiers: databinding
The ping of the server in milliseconds
Players[edit]
Type: array<PlayerRecord>
Players currently playing on the server
ServerIP[edit]
Type: string
Modifiers: databinding, const
The IP:Port of the server (set clientside when receiving server data)
ServerNonce[edit]
Type: byte
Array size: 8
Modifiers: const
The server's nonce for this session
Enums[edit]
EDedicatedServerType[edit]
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[edit]
PlayerRecord[edit]
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[edit]
TrimDataBindingValue[edit]
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[edit]
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[edit]
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
