- Package:
- UTGame
- Direct subclasses:
- UTGameSettingsCTF, UTGameSettingsCampaign, UTGameSettingsDM, UTGameSettingsDUEL, UTGameSettingsPersonal, UTGameSettingsTDM, UTGameSettingsVCTF, UTGameSettingsWAR, UTGameSettingsBetrayal, UTGameSettingsGreed
- This class in other games:
- UDK
Holds the settings that are common to all match types
Constants[edit]
See UTGameSettingsCommon constants.
Properties[edit]
MaxPlayers[edit]
Type: int
Modifiers: databinding
The maximum number of players allowed on this server.
Default value: 16
MinNetPlayers[edit]
Type: int
Modifiers: databinding
The minumum number of players that must be present before the match starts.
Default values[edit]
Functions[edit]
Static native functions[edit]
BlobToString[edit]
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[edit]
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.
TrimPropertyValue[edit]
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[edit]
BuildURL[edit]
function
BuildURL (out
string OutURL)
Overrides: Settings.BuildURL
Builds a URL string out of the properties/contexts and databindings of this object.
GenerateMutatorBitmaskFromURL[edit]
function
int GenerateMutatorBitmaskFromURL (const out
string URL)
OBSOLETE - use NewGenerateMutatorBitmaskFromURL()
NewGenerateMutatorBitmaskFromURL[edit]
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[edit]
function
SetCustomMapName (
string MapName)
Sets the property that advertises the custom map name
Parameters:
- MapName - the string to use
SetCustomMutators[edit]
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[edit]
function
SetMutators (const out
string URL)
SetOfficialMutatorBitmask[edit]
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[edit]
Overrides: Settings.UpdateFromURL
Updates the game settings object from parameters passed on the URL
Parameters:
- URL - the URL to parse for settings