UE3:UTGameSettingsCommon (UT3)

From Unreal Wiki, The Unreal Engine Documentation Site
UT3 Object >> Settings >> OnlineGameSettings >> UTGameSettingsCommon
Package:
UTGame
Direct subclasses:
UTGameSettingsCTF, UTGameSettingsCampaign, UTGameSettingsDM, UTGameSettingsDUEL, UTGameSettingsPersonal, UTGameSettingsTDM, UTGameSettingsVCTF, UTGameSettingsWAR, UTGameSettingsBetrayal, UTGameSettingsGreed
This class in other games:
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 settings that are common to all match types

Constants

See UTGameSettingsCommon constants.

Properties

MaxPlayers

Type: int

Modifiers: databinding

The maximum number of players allowed on this server.

Default value: 16

MinNetPlayers

Type: int

Modifiers: databinding

The minumum number of players that must be present before the match starts.

Default values

Property Value
LocalizedSettings[0]
Member Value
AdvertisementType ODAT_OnlineService
Id 32779
LocalizedSettings[1]
Member Value
AdvertisementType ODAT_OnlineService
ValueIndex 2
LocalizedSettings[2]
Member Value
AdvertisementType ODAT_OnlineService
Id 1
LocalizedSettings[3]
Member Value
AdvertisementType ODAT_OnlineService
Id 6
ValueIndex 1
LocalizedSettings[4]
Member Value
AdvertisementType ODAT_OnlineService
Id 7
LocalizedSettings[5]
Member Value
AdvertisementType ODAT_OnlineService
Id 8
LocalizedSettings[6]
Member Value
AdvertisementType ODAT_OnlineService
Id 9
LocalizedSettings[7]
Member Value
AdvertisementType ODAT_OnlineService
Id 10
LocalizedSettings[8]
Member Value
AdvertisementType ODAT_OnlineService
Id 11
LocalizedSettings[9]
Member Value
AdvertisementType ODAT_OnlineService
Id 12
LocalizedSettings[10]
Member Value
AdvertisementType ODAT_OnlineService
Id 13
ValueIndex 1
LocalizedSettings[11]
Member Value
AdvertisementType ODAT_OnlineService
Id 14
LocalizedSettingsMappings[0]
Member Value
ColumnHeaderText "Game"
Id 32779
Name 'GameMode'
ValueMappings
Member Value
Name 'Deathmatch'
Member Value
Id 4
Name 'Team Deathmatch'
Member Value
Id 1
Name 'Capture The Flag'
Member Value
Id 3
Name 'Vehicle CTF'
Member Value
Id 2
Name 'Warfare'
Member Value
Id 5
Name 'Duel'
Member Value
Id 7
Name 'Campaign'
Member Value
Id 8
Name 'Greed'
Member Value
Id 9
Name 'Betrayal'
Member Value
Id 6
Name 'Custom'
LocalizedSettingsMappings[1]
Member Value
ColumnHeaderText "Bot Skill"
Name 'BotSkill'
ValueMappings
Member Value
Id 1
Name 'Novice'
Member Value
Id 2
Name 'Average'
Member Value
Id 3
Name 'Experienced'
Member Value
Id 4
Name 'Skilled'
Member Value
Id 5
Name 'Adept'
Member Value
Id 6
Name 'Masterful'
Member Value
Id 7
Name 'Inhuman'
Member Value
Id 8
Name 'Godlike'
LocalizedSettingsMappings[2]
Member Value
ColumnHeaderText "Map"
Id 1
Name 'MapName'
ValueMappings
Member Value
Name 'Custom'
LocalizedSettingsMappings[3]
Member Value
ColumnHeaderText "Pure"
Id 6
Name 'PureServer'
ValueMappings
Member Value
Name 'No'
Member Value
Id 1
Name 'Yes'
LocalizedSettingsMappings[4]
Member Value
ColumnHeaderText "Locked"
Id 7
Name 'LockedServer'
ValueMappings
Member Value
Name 'No'
Member Value
Id 1
Name 'Yes'
LocalizedSettingsMappings[5]
Member Value
ColumnHeaderText "Vs Bots"
Id 8
Name 'VsBots'
ValueMappings
Member Value
Name 'Disabled'
Member Value
Id 2
Name '1:1'
Member Value
Id 3
Name '3:2'
Member Value
Id 4
Name '2:1'
LocalizedSettingsMappings[6]
Member Value
ColumnHeaderText "Campaign"
Id 9
Name 'Campaign'
ValueMappings
Member Value
Name 'No'
Member Value
Id 1
Name 'Yes'
LocalizedSettingsMappings[7]
Member Value
ColumnHeaderText "Forced Respawn"
Id 10
Name 'ForceRespawn'
ValueMappings
Member Value
Name 'No'
Member Value
Id 1
Name 'Yes'
LocalizedSettingsMappings[8]
Member Value
ColumnHeaderText "M/KB"
Id 11
Name 'AllowKeyboard'
ValueMappings
Member Value
Name 'No'
Member Value
Id 1
Name 'Yes'
LocalizedSettingsMappings[9]
Member Value
ColumnHeaderText "Full"
Id 12
Name 'IsFullServer'
ValueMappings
Member Value
Name 'No'
Member Value
Id 1
Name 'Yes'
LocalizedSettingsMappings[10]
Member Value
ColumnHeaderText "Empty"
Id 13
Name 'IsEmptyServer'
ValueMappings
Member Value
Name 'No'
Member Value
Id 1
Name 'Yes'
LocalizedSettingsMappings[11]
Member Value
ColumnHeaderText "Dedicated"
Id 14
Name 'IsDedicated'
ValueMappings
Member Value
Name 'No'
Member Value
Id 1
Name 'Yes'
NumPublicConnections 16
OptionalDataBindingSettings[0] 'AverageSkillRating'
OptionalLocalizedSettings[1] 8
OptionalLocalizedSettings[2] 10
OptionalPropertySettings[0] 268435704
OptionalPropertySettings[1] 268435705
OptionalPropertySettings[2] 1073741828
OptionalPropertySettings[3] 1073741829
Properties[0]
Member Value
AdvertisementType ODAT_QoS
Data
Member Value
Type SDT_String
PropertyId 1073741825
Properties[1]
Member Value
AdvertisementType ODAT_QoS
Data
Member Value
Type SDT_String
PropertyId 1073741826
Properties[2]
Member Value
AdvertisementType ODAT_OnlineService
Data
Member Value
Type SDT_Int32
Value1 20
PropertyId 268435704
Properties[3]
Member Value
AdvertisementType ODAT_OnlineService
Data
Member Value
Type SDT_Int32
Value1 20
PropertyId 268435705
Properties[4]
Member Value
AdvertisementType ODAT_OnlineService
Data
Member Value
Type SDT_Int32
Value1 6
PropertyId 268435703
Properties[5]
Member Value
AdvertisementType ODAT_QoS
Data
Member Value
Type SDT_String
PropertyId 1073741827
Properties[6]
Member Value
AdvertisementType ODAT_OnlineService
Data
Member Value
Type SDT_Int32
PropertyId 268435717
Properties[7]
Member Value
AdvertisementType ODAT_QoS
Data
Member Value
Type SDT_String
PropertyId 1073741828
Properties[8]
Member Value
AdvertisementType ODAT_QoS
Data
Member Value
Type SDT_String
PropertyId 1073741829
Properties[9]
Member Value
Data
Member Value
Type SDT_Int32
Value1 6
PropertyId 268435706
Properties[10]
Member Value
Data
Member Value
Type SDT_Int64
PropertyId 268435968
Properties[11]
Member Value
Data
Member Value
Type SDT_Int32
PropertyId 268435969
PropertyMappings[0]
Member Value
ColumnHeaderText "Map"
Id 1073741825
Name 'CustomMapName'
PropertyMappings[1]
Member Value
ColumnHeaderText "Game"
Id 1073741826
Name 'CustomGameMode'
PropertyMappings[2]
Member Value
ColumnHeaderText "Goal Score"
Id 268435704
MappingType PVMT_PredefinedValues
Name 'GoalScore'
PredefinedValues
Member Value
Type SDT_Int32
Member Value
Type SDT_Int32
Value1 5
Member Value
Type SDT_Int32
Value1 10
Member Value
Type SDT_Int32
Value1 15
Member Value
Type SDT_Int32
Value1 20
Member Value
Type SDT_Int32
Value1 25
Member Value
Type SDT_Int32
Value1 30
Member Value
Type SDT_Int32
Value1 35
Member Value
Type SDT_Int32
Value1 40
Member Value
Type SDT_Int32
Value1 45
Member Value
Type SDT_Int32
Value1 50
Member Value
Type SDT_Int32
Value1 55
Member Value
Type SDT_Int32
Value1 60
Member Value
Type SDT_Int32
Value1 70
Member Value
Type SDT_Int32
Value1 80
Member Value
Type SDT_Int32
Value1 90
Member Value
Type SDT_Int32
Value1 100
Member Value
Type SDT_Int32
Value1 125
Member Value
Type SDT_Int32
Value1 150
PropertyMappings[3]
Member Value
ColumnHeaderText "Time Limit"
Id 268435705
MappingType PVMT_PredefinedValues
Name 'TimeLimit'
PredefinedValues
Member Value
Type SDT_Int32
Member Value
Type SDT_Int32
Value1 5
Member Value
Type SDT_Int32
Value1 10
Member Value
Type SDT_Int32
Value1 15
Member Value
Type SDT_Int32
Value1 20
Member Value
Type SDT_Int32
Value1 30
Member Value
Type SDT_Int32
Value1 45
Member Value
Type SDT_Int32
Value1 60
PropertyMappings[4]
Member Value
ColumnHeaderText "Bots"
Id 268435703
MappingType PVMT_PredefinedValues
Name 'NumBots'
PredefinedValues
Member Value
Type SDT_Int32
Member Value
Type SDT_Int32
Value1 1
Member Value
Type SDT_Int32
Value1 2
Member Value
Type SDT_Int32
Value1 3
Member Value
Type SDT_Int32
Value1 4
Member Value
Type SDT_Int32
Value1 5
Member Value
Type SDT_Int32
Value1 6
Member Value
Type SDT_Int32
Value1 7
Member Value
Type SDT_Int32
Value1 8
Member Value
Type SDT_Int32
Value1 9
Member Value
Type SDT_Int32
Value1 10
Member Value
Type SDT_Int32
Value1 11
Member Value
Type SDT_Int32
Value1 12
Member Value
Type SDT_Int32
Value1 13
Member Value
Type SDT_Int32
Value1 14
Member Value
Type SDT_Int32
Value1 15
Member Value
Type SDT_Int32
Value1 16
PropertyMappings[5]
Member Value
ColumnHeaderText "Server Description"
Id 1073741827
Name 'ServerDescription'
PropertyMappings[6]
Member Value
ColumnHeaderText "Mutators"
Id 268435717
Name 'OfficialMutators'
PropertyMappings[7]
Member Value
Id 1073741828
Name 'CustomMutators'
PropertyMappings[8]
Member Value
Id 1073741829
Name 'CustomMutClasses'
PropertyMappings[9]
Member Value
ColumnHeaderText "Bots"
Id 268435706
MappingType PVMT_PredefinedValues
Name 'NumBotsIA'
PredefinedValues
Member Value
Type SDT_Int32
Member Value
Type SDT_Int32
Value1 1
Member Value
Type SDT_Int32
Value1 2
Member Value
Type SDT_Int32
Value1 3
Member Value
Type SDT_Int32
Value1 4
Member Value
Type SDT_Int32
Value1 5
Member Value
Type SDT_Int32
Value1 6
Member Value
Type SDT_Int32
Value1 7
Member Value
Type SDT_Int32
Value1 8
Member Value
Type SDT_Int32
Value1 9
Member Value
Type SDT_Int32
Value1 10
Member Value
Type SDT_Int32
Value1 11
Member Value
Type SDT_Int32
Value1 12
Member Value
Type SDT_Int32
Value1 13
Member Value
Type SDT_Int32
Value1 14
Member Value
Type SDT_Int32
Value1 15
Member Value
Type SDT_Int32
Value1 16
PropertyMappings[10]
Member Value
Id 268435968
Name 'SteamID'
PropertyMappings[11]
Member Value
Id 268435969
Name 'SteamVAC'

Functions

Static native functions

BlobToString

native static function string BlobToString (const out string InBlob)

Converts a hexified blob to a normal string.

Parameters:

  • InBlob - String to convert back.

Returns:

Returns whether or not the string was converted.

StringToBlob

native static function bool StringToBlob (const out string InString, out string OutBlob)

Converts a string to a hexified blob.

Parameters:

  • InString - String to convert.
  • OutBlob - Resulting blob

Returns:

Returns whether or not the string was converted.

Events

TrimPropertyValue

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

Overrides: OnlineGameSettings.TrimPropertyValue

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

Other instance functions

BuildURL

function BuildURL (out string OutURL)

Overrides: Settings.BuildURL

Builds a URL string out of the properties/contexts and databindings of this object.

GenerateMutatorBitmaskFromURL

function int GenerateMutatorBitmaskFromURL (const out string URL)

OBSOLETE - use NewGenerateMutatorBitmaskFromURL()

NewGenerateMutatorBitmaskFromURL

function int NewGenerateMutatorBitmaskFromURL (UTUIDataStore_MenuItems MenuDataStore, out array<string> MutatorClassNames)

Generates a bitmask of active mutators which were created by epic. The bits are derived by left-shifting by the mutator's index into the UTUIDataStore_MenuItems' list of UTUIDataProvider_Mutators.

Returns:

a bitmask which has bits on for any enabled official mutators.

SetCustomMapName

function SetCustomMapName (string MapName)

Sets the property that advertises the custom map name

Parameters:

  • MapName - the string to use

SetCustomMutators

function SetCustomMutators (UTUIDataStore_MenuItems MenuDataStore, const out array<string> MutatorClassNames)

Sets the custom mutators property with a delimited string containing the friendly names for all active custom (non-epic) mutators.

Parameters:

  • MenuDataStore - the data store which contains the UI data for all game resources (mutators, maps, gametypes, etc.)
  • MutatorClassNames - the array of pathnames for all mutators currently active in the game

SetMutators

function SetMutators (const out string URL)


SetOfficialMutatorBitmask

function SetOfficialMutatorBitmask (int MutatorBitmask)

Sets the property that advertises the official mutators being used in the game.

Parameters:

  • MutatorBitmask - bitmask of epic mutators that are active for this game session (bits are derived by left-shifting by the mutator's index into the UTUIDataStore_MenuItems' list of UTUIDataProvider_Mutators

UpdateFromURL

function UpdateFromURL (const out string URL, GameInfo Game)

Overrides: Settings.UpdateFromURL

Updates the game settings object from parameters passed on the URL

Parameters:

  • URL - the URL to parse for settings
Retrieved from "https://wiki.beyondunreal.com/index.php?title=UE3:UTGameSettingsCommon_(UT3)&oldid=35148"