The three virtues of a programmer: Laziness, Impatience, and Hubris. – Larry Wall

UE3:UTMapListManager (UT3)

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
UT3 Object >> Actor >> Info >> UTMapListManager
Package: 
UTGame

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

Properties

ActiveGameProfile

Type: int

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

Default value: -1

ActiveGameProfileName

Type: string

Modifiers: globalconfig

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

ActiveMapList

Type: UTMapList

The currently active maplist for this gametype

AddedMutators

Type: array<string>

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

AutoEmptyOptions

Type: string

Modifiers: globalconfig

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

Default value: "GoalScore"

AutoStripOptions

Type: string

Modifiers: globalconfig

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

Default value: "LinkSetup"

AvailableGameProfiles

Type: array<GameProfile>

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

bGotMapListSections

Type: bool

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

bOverrideNextMap

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

Type: bool

Used to help detect bad maps

GameProfiles

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

Type: array<UTMapList>

Cache of loaded maplists

MapReplayLimit

Type: int

Modifiers: globalconfig

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

PlayIndex

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

Type: int

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

Default value: -1

UnloadedMapLists

Type: array<string>

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

Default values

Property Value
CollisionType COLLIDE_CustomDefault

Subobjects

Sprite

Class: Engine.SpriteComponent

Inherits from: Info.Sprite

No new values.

Structs

GameProfile

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

Static functions

ContainsOptions

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


CreateNewGameProfile

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


ModifyMutatorOptions

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


PopulateMapListByPrefix

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


StaticFindGameProfileIndex

static final function int StaticFindGameProfileIndex (string GameClass)


StaticGetCurrentGameProfileIndex

static final function int StaticGetCurrentGameProfileIndex ()


StaticGetMapListByName

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


StripOption

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


Instance functions

AddDefaultOptions

function string AddDefaultOptions (string CurOptions)


bMapEnabled

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


FindGameProfileIndex

function int FindGameProfileIndex (string GameClass)


GetCurrentGameProfileIndex

function int GetCurrentGameProfileIndex ()


GetCurrentMapList

function UTMapList GetCurrentMapList (optional bool bForceUpdate)


GetDefaultMutators

final function string GetDefaultMutators (int Idx)


GetDisabledDefaultMutators

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


GetMapLastPlayDiff

function int GetMapLastPlayDiff (UTMapList MapList, int MapIdx)


GetMapListByName

function UTMapList GetMapListByName (name MapListName, optional bool bCreate)


GetNextMap

function string GetNextMap (optional UTMapList InMapList)


Initialize

function Initialize ()


ModifyOptions

function ModifyOptions (out string CurOptions)


NotifyMapChange

function NotifyMapChange (string NextMap)


NotifyTravelFailed

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


SetCurrentGameProfileIndex

function SetCurrentGameProfileIndex (int Idx)


UpdateMapHistory

function UpdateMapHistory (UTMapList MapList, int MapIdx)