I love the smell of UnrealEd crashing in the morning. – tarquin

UE3:UTMapListManager (UT3)

From Unreal Wiki, The Unreal Engine Documentation Site
(Redirected from UE3:GameProfile (UT3))
Jump to: navigation, search
UT3 Object >> Actor >> Info >> UTMapListManager
Package: 
UTGame

Copyright 1998-2008 Epic Games, Inc. All Rights Reserved.

Properties[edit]

ActiveGameProfile[edit]

Type: int

The currently active game profile; used to determine the current map cycle

Default value: -1

ActiveGameProfileName[edit]

Type: string

Modifiers: globalconfig

The currently active game profile; used to help determine the current map cycle

ActiveMapList[edit]

Type: UTMapList

The currently active maplist for this gametype

AddedMutators[edit]

Type: array<string>

Mutators added to the URL in 'AddDefaultOptions'; used by 'ModifyOptions' when switching between game profiles

AutoEmptyOptions[edit]

Type: string

Modifiers: globalconfig

The same as 'AutoStripOptions', except these options are given an empty value on the URL

Default value: "GoalScore"

AutoStripOptions[edit]

Type: string

Modifiers: globalconfig

A list of URL options which are automatically removed from the URL upon map change

Default value: "LinkSetup"

AvailableGameProfiles[edit]

Type: array<GameProfile>

Runtime copy of the 'GameProfiles' list, so that editing through webadmin doesn't break the code

bGotMapListSections[edit]

Type: bool

If true, 'UnLoadedMapLists' has been filled from UTMapLists.ini

bOverrideNextMap[edit]

Type: bool

Forces the current GameInfo to use the map supplies by this object, instead of e.g. that supplied by the vote collector

bPendingMapChange[edit]

Type: bool

Used to help detect bad maps

GameProfiles[edit]

Type: array<GameProfile>

Modifiers: globalconfig

The list of available game profiles

Default value, index 0:

Member Value
GameClass "UTGame.UTDeathmatch"
GameName "DeathMatch"
MapListName 'DMMapList'

Default value, index 1:

Member Value
bIsTeamGame True
GameClass "UTGame.UTTeamGame"
GameName "Team DeathMatch"
MapListName 'TDMMapList'

Default value, index 2:

Member Value
bIsTeamGame True
GameClass "UTGameContent.UTCTFGame_Content"
GameName "Capture The Flag"
MapListName 'CTFMapList'

Default value, index 3:

Member Value
bIsTeamGame True
GameClass "UTGameContent.UTVehicleCTFGame_Content"
GameName "Vehicle Capture The Flag"
MapListName 'VCTFMapList'

Default value, index 4:

Member Value
bIsTeamGame True
GameClass "UTGameContent.UTOnslaughtGame_Content"
GameName "Warfare"
MapListName 'WARMapList'

Default value, index 5:

Member Value
GameClass "UTGame.UTDuelGame"
GameName "Duel"
MapListName 'DuelMapList'

Default value, index 6:

Member Value
GameClass "UTGame.UTBetrayalGame"
GameName "Betrayal"
MapListName 'BetrayalMapList'

Default value, index 7:

Member Value
bIsTeamGame True
GameClass "UT3GoldGame.UTGreedGame_Content"
GameName "Greed"
MapListName 'GreedMapList'

LoadedMapLists[edit]

Type: array<UTMapList>

Cache of loaded maplists

MapReplayLimit[edit]

Type: int

Modifiers: globalconfig

After a map has been played, this many matches must pass before the map can be played again

PlayIndex[edit]

Type: int

Modifiers: globalconfig

The index of the current game session, incremented upon map switch (used to keep track of when maps have been played)

StartupGameProfile[edit]

Type: int

The game profile that was active when the maplist manager was initialized

Default value: -1

UnloadedMapLists[edit]

Type: array<string>

List of maplist names from UTMapLists.ini which have not been loaded into 'MapListCache'

Default values[edit]

Property Value
CollisionType COLLIDE_CustomDefault

Subobjects[edit]

Sprite[edit]

Class: Engine.SpriteComponent

Inherits from: Info.Sprite

No new values.

Structs[edit]

GameProfile[edit]

A struct for describing a gametype and it's corresponding settings

string GameClass 
The game class this profile uses, must be in the format: 'Package.Class'
string GameName 
The displayed gametype name (e.g "Warfare", "Capture The Flag")
name MapListName 
The name of the maplist this gametype uses (maplists are defined in UTMapLists.ini)
string Options 
Added URL options used with this game profile
string Mutators 
A list of default mutators which are used with this game profile, format: 'Pkg.Class,Pkg2.Class2'
string ExcludedMuts 
A list of mutators which are disallowed when playing under this game profile
bool bIsTeamGame 
Whether this gametype is a team game (saves loading gametype to find out)

Default values:

Property Value
bIsTeamGame False

Functions[edit]

Static functions[edit]

ContainsOptions[edit]

static final function bool ContainsOptions (string A, string B)


CreateNewGameProfile[edit]

static final function GameProfile CreateNewGameProfile (string InGameClass, optional string InGameName, optional name InMapListName, optional string InOptions, optional string InMutators)


ModifyMutatorOptions[edit]

static final function ModifyMutatorOptions (out string CurOptions, optional out const array<stringAddMuts, optional out const array<stringRemoveMuts)


PopulateMapListByPrefix[edit]

static final function PopulateMapListByPrefix (UTMapList MapList, array<stringPrefixes, optional bool bAppend)


StaticFindGameProfileIndex[edit]

static final function int StaticFindGameProfileIndex (string GameClass)


StaticGetCurrentGameProfileIndex[edit]

static final function int StaticGetCurrentGameProfileIndex ()


StaticGetMapListByName[edit]

static final function UTMapList StaticGetMapListByName (name MapListName, optional bool bCreate)


StripOption[edit]

static final function string StripOption (string Options, string InKey, optional bool bAddEmptyValue)


Instance functions[edit]

AddDefaultOptions[edit]

function string AddDefaultOptions (string CurOptions)


bMapEnabled[edit]

function bool bMapEnabled (UTMapList MapList, int MapIdx, optional bool bStrict)


FindGameProfileIndex[edit]

function int FindGameProfileIndex (string GameClass)


GetCurrentGameProfileIndex[edit]

function int GetCurrentGameProfileIndex ()


GetCurrentMapList[edit]

function UTMapList GetCurrentMapList (optional bool bForceUpdate)


GetDefaultMutators[edit]

final function string GetDefaultMutators (int Idx)


GetDisabledDefaultMutators[edit]

final function array<stringGetDisabledDefaultMutators (const out array<stringOldDefaults, const out array<stringNewDefaults)


GetMapLastPlayDiff[edit]

function int GetMapLastPlayDiff (UTMapList MapList, int MapIdx)


GetMapListByName[edit]

function UTMapList GetMapListByName (name MapListName, optional bool bCreate)


GetNextMap[edit]

function string GetNextMap (optional UTMapList InMapList)


Initialize[edit]

function Initialize ()


ModifyOptions[edit]

function ModifyOptions (out string CurOptions)


NotifyMapChange[edit]

function NotifyMapChange (string NextMap)


NotifyTravelFailed[edit]

function NotifyTravelFailed (string TravelURL, string Error, optional string ErrorCode)


SetCurrentGameProfileIndex[edit]

function SetCurrentGameProfileIndex (int Idx)


UpdateMapHistory[edit]

function UpdateMapHistory (UTMapList MapList, int MapIdx)