Overview Package Class Source Class tree Glossary
previous class      next class frames      no frames

UTGame.UTUIFrontEnd_MapCycle

Extends
UTUIFrontEnd
Modifiers
dependson ( UTGame , UTMapListManager )

Copyright 1998-2008 Epic Games, Inc. All Rights Reserved. UI scene that allows the user to setup a map cycle.

Core.Object
|   
+-- Engine.UIRoot
   |   
   +-- Engine.UIScreenObject
      |   
      +-- Engine.UIScene
         |   
         +-- UTGame.UTUIScene
            |   
            +-- UTGame.UTUIFrontEnd
               |   
               +-- UTGame.UTUIFrontEnd_MapCycle

Constants Summary
Inherited Contants from UTGame.UTUIScene
CONTEXT_ALLOWKEYBOARD, CONTEXT_ALLOWKEYBOARD_ANY, CONTEXT_ALLOWKEYBOARD_NO, CONTEXT_ALLOWKEYBOARD_YES, CONTEXT_BOTSKILL, CONTEXT_BOTSKILL_ADEPT, CONTEXT_BOTSKILL_AUTOADJUSTSKILL, CONTEXT_BOTSKILL_AVERAGE, CONTEXT_BOTSKILL_EXPERIENCED, CONTEXT_BOTSKILL_GODLIKE, CONTEXT_BOTSKILL_INHUMAN, CONTEXT_BOTSKILL_MASTERFUL, CONTEXT_BOTSKILL_NOVICE, CONTEXT_BOTSKILL_SKILLED, CONTEXT_CAMPAIGN, CONTEXT_CAMPAIGN_NO, CONTEXT_CAMPAIGN_YES, CONTEXT_DEDICATEDSERVER, CONTEXT_DEDICATEDSERVER_NO, CONTEXT_DEDICATEDSERVER_YES, CONTEXT_EMPTYSERVER, CONTEXT_EMPTYSERVER_NO, CONTEXT_EMPTYSERVER_YES, CONTEXT_FORCERESPAWN, CONTEXT_FORCERESPAWN_NO, CONTEXT_FORCERESPAWN_YES, CONTEXT_FULLSERVER, CONTEXT_FULLSERVER_NO, CONTEXT_FULLSERVER_YES, CONTEXT_GAME_MODE, CONTEXT_GAME_MODE_BETRAYAL, CONTEXT_GAME_MODE_CAMPAIGN, CONTEXT_GAME_MODE_CTF, CONTEXT_GAME_MODE_CUSTOM, CONTEXT_GAME_MODE_DM, CONTEXT_GAME_MODE_DUEL, CONTEXT_GAME_MODE_GREED, CONTEXT_GAME_MODE_TDM, CONTEXT_GAME_MODE_VCTF, CONTEXT_GAME_MODE_WAR, CONTEXT_GOALSCORE_10, CONTEXT_GOALSCORE_15, CONTEXT_GOALSCORE_20, CONTEXT_GOALSCORE_30, CONTEXT_GOALSCORE_5, CONTEXT_LOCKEDSERVER, CONTEXT_LOCKEDSERVER_NO, CONTEXT_LOCKEDSERVER_YES, CONTEXT_MAPNAME, CONTEXT_MAPNAME_ARSENAL, CONTEXT_MAPNAME_AVALANCHE, CONTEXT_MAPNAME_BIOHAZARD, CONTEXT_MAPNAME_CARBON_FIRE, CONTEXT_MAPNAME_COLDHARBOR, CONTEXT_MAPNAME_CONFRONTATION, CONTEXT_MAPNAME_CONTAINMENT, CONTEXT_MAPNAME_CONTAINMENTSP, CONTEXT_MAPNAME_CORET, CONTEXT_MAPNAME_CORRUPTION, CONTEXT_MAPNAME_CUSTOM, CONTEXT_MAPNAME_DARKMATCH, CONTEXT_MAPNAME_DECK, CONTEXT_MAPNAME_DEFIANCE, CONTEXT_MAPNAME_DEIMOS, CONTEXT_MAPNAME_DIESEL, CONTEXT_MAPNAME_DOWNTOWN, CONTEXT_MAPNAME_DOWNTOWNNECRIS, CONTEXT_MAPNAME_DUSK, CONTEXT_MAPNAME_EDENINC, CONTEXT_MAPNAME_FACINGWORLDS, CONTEXT_MAPNAME_FEARLESS, CONTEXT_MAPNAME_FLOODGATE, CONTEXT_MAPNAME_GATEWAY, CONTEXT_MAPNAME_HEAT_RAY, CONTEXT_MAPNAME_HOSTILE, CONTEXT_MAPNAME_HYDROSIS, CONTEXT_MAPNAME_ISLANDER, CONTEXT_MAPNAME_ISLANDERNECRIS, CONTEXT_MAPNAME_KARGO, CONTEXT_MAPNAME_KBARGE, CONTEXT_MAPNAME_LOSTCAUSE, CONTEXT_MAPNAME_MARKET_DISTRICT, CONTEXT_MAPNAME_MISSION_SELECTION, CONTEXT_MAPNAME_MORBIAS, CONTEXT_MAPNAME_MORBID, CONTEXT_MAPNAME_NANOBLACK, CONTEXT_MAPNAME_NECROPOLIS, CONTEXT_MAPNAME_OCEANRELIC, CONTEXT_MAPNAME_OMICRON_DAWN, CONTEXT_MAPNAME_ONYX_COAST, CONTEXT_MAPNAME_POWER_SURGE, CONTEXT_MAPNAME_RAILS, CONTEXT_MAPNAME_REFLECTION, CONTEXT_MAPNAME_RISING_SUN, CONTEXT_MAPNAME_SANCTUARY, CONTEXT_MAPNAME_SANDSTORM, CONTEXT_MAPNAME_SEARCHLIGHT, CONTEXT_MAPNAME_SENTINEL, CONTEXT_MAPNAME_SERENITY, CONTEXT_MAPNAME_SERENITYNECRIS, CONTEXT_MAPNAME_SHAFT, CONTEXT_MAPNAME_SHANGRILA, CONTEXT_MAPNAME_SINKHOLE, CONTEXT_MAPNAME_STRANDED, CONTEXT_MAPNAME_STRIDENT, CONTEXT_MAPNAME_SUSPENSE, CONTEXT_MAPNAME_SUSPENSE_NECRIS, CONTEXT_MAPNAME_TANK_CROSSING, CONTEXT_MAPNAME_TORLAN, CONTEXT_MAPNAME_TORLANLEVIATHAN, CONTEXT_MAPNAME_TORLANNECRIS, CONTEXT_MAPNAME_TURBINE, CONTEXT_MAPNAME_VERTEBRAE, CONTEXT_NUMBOTS_0, CONTEXT_NUMBOTS_1, CONTEXT_NUMBOTS_2, CONTEXT_NUMBOTS_3, CONTEXT_NUMBOTS_4, CONTEXT_NUMBOTS_5, CONTEXT_NUMBOTS_6, CONTEXT_NUMBOTS_7, CONTEXT_NUMBOTS_8, CONTEXT_PRESENCE_MENUPRESENCE, CONTEXT_PURESERVER, CONTEXT_PURESERVER_ANY, CONTEXT_PURESERVER_NO, CONTEXT_PURESERVER_YES, CONTEXT_TIMELIMIT_10, CONTEXT_TIMELIMIT_15, CONTEXT_TIMELIMIT_20, CONTEXT_TIMELIMIT_30, CONTEXT_TIMELIMIT_5, CONTEXT_VSBOTS, CONTEXT_VSBOTS_1_TO_1, CONTEXT_VSBOTS_1_TO_2, CONTEXT_VSBOTS_2_TO_1, CONTEXT_VSBOTS_3_TO_1, CONTEXT_VSBOTS_3_TO_2, CONTEXT_VSBOTS_4_TO_1, CONTEXT_VSBOTS_NONE, GS_CDKEY_PART_MAXLENGTH, GS_EMAIL_MAXLENGTH, GS_MESSAGE_MAXLENGTH, GS_PASSWORD_MAXLENGTH, GS_USERNAME_MAXLENGTH, PROPERTY_CUSTOMGAMEMODE, PROPERTY_CUSTOMMAPNAME, PROPERTY_CUSTOMMUTATORS, PROPERTY_CUSTOMMUTCLASSES, PROPERTY_EPICMUTATORS, PROPERTY_GOALSCORE, PROPERTY_LEADERBOARDRATING, PROPERTY_NUMBOTS, PROPERTY_NUMBOTSIA, PROPERTY_SERVERDESCRIPTION, PROPERTY_STEAMID, PROPERTY_STEAMVAC, PROPERTY_TIMELIMIT, QUERY_BETRAYAL, QUERY_CAMPAIGN, QUERY_CTF, QUERY_DM, QUERY_DUEL, QUERY_GREED, QUERY_TDM, QUERY_VCTF, QUERY_WAR, STATS_VIEW_DM_PLAYER_ALLTIME, STATS_VIEW_DM_RANKED_ALLTIME, STATS_VIEW_DM_VEHICLES_ALLTIME, STATS_VIEW_DM_VEHICLES_RANKED_ALLTIME, STATS_VIEW_DM_VEHICLEWEAPONS_ALLTIME, STATS_VIEW_DM_VEHICLEWEAPONS_RANKED_ALLTIME, STATS_VIEW_DM_WEAPONS_ALLTIME, STATS_VIEW_DM_WEAPONS_RANKED_ALLTIME

Variables Summary
UIListAvailableList
UILabelDescriptionLabel
UIListEnabledList
UIListLastFocused
UTMapListLoadedMapList
UTUIDataStore_MenuItemsMenuDataStore
UIImageShiftLeftImage
UIImageShiftRightImage
Inherited Variables from UTGame.UTUIFrontEnd
bCancellingInstallPS3, bInstallingPS3, ButtonBar, CurrentPageIndex, ImportingMessageBoxReference, ImportState, LastURL, PreviousPageIndex, TabControl, TitleMarkupString, VersionFont, VersionPos, VersionText
Inherited Variables from UTGame.UTUIScene
bEditorRealTimePreview, bHidingScene, bIgnoreAxisInput, bShowingScene, bSkipPendingCloseSceneNotify, InputBoxScene, MessageBoxScene, OnlineToastScene, PendingCloseScene, PendingOpenScene, PlayerCardScene

Enumerations Summary
Inherited Enumerations from UTGame.UTUIFrontEnd
EModImport
Inherited Enumerations from UTGame.UTUIScene
EUTBotTeam, EUTRecordDemo

Functions Summary
function GenerateMapCycleList (out GameMapCycle Cycle))
function GenerateMapCycleListNew (out UTMapList MLObj))
functionname GetCurrentGameMode ()))
functionname GetCurrentGameModeFull ()))
functionstring GrabOptions (string InURL))
functionbool HandleInputKey (const out InputEventParameters EventParms ))
function LoadMapCycle ()))
function OnAccept ()))
function OnAvailableList_NotifyActiveStateChanged (UIScreenObject Sender, int PlayerIndex, UIState NewlyActiveState, optional UIState PreviouslyActiveState ))
function OnAvailableList_SubmitSelection (UIList Sender, optional int PlayerIndex=GetBestPlayerIndex() ))
function OnAvailableList_ValueChanged (UIObject Sender, int PlayerIndex ))
function OnBack ()))
functionbool OnButtonBar_Accept (UIScreenObject InButton, int PlayerIndex))
functionbool OnButtonBar_Back (UIScreenObject InButton, int PlayerIndex))
functionbool OnButtonBar_ClearMaps (UIScreenObject InButton, int PlayerIndex))
functionbool OnButtonBar_MoveMap (UIScreenObject InButton, int PlayerIndex))
functionbool OnButtonBar_ShiftDown (UIScreenObject InButton, int PlayerIndex))
functionbool OnButtonBar_ShiftUp (UIScreenObject InButton, int PlayerIndex))
function OnClearMaps ()))
function OnEnabledList_NotifyActiveStateChanged (UIScreenObject Sender, int PlayerIndex, UIState NewlyActiveState, optional UIState PreviouslyActiveState ))
function OnEnabledList_SubmitSelection (UIList Sender, optional int PlayerIndex=GetBestPlayerIndex() ))
function OnEnabledList_ValueChanged (UIObject Sender, int PlayerIndex ))
function OnMapListChanged ()))
functionbool OnMapList_RawInputKey (const out InputEventParameters EventParms ))
function OnMoveMap ()))
function OnSelectedMapChanged ()))
function OnShiftMap (bool bShiftUp))
event PostInitialize ()))
function SaveMapCycle ()))
function SetupButtonBar ()))
functionstring StripOptions (coerce string InURL))
function UpdateDescriptionLabel ()))
Inherited Functions from UTGame.UTUIFrontEnd
BeginHideAnimation, BeginImportMod, BeginInstallPS3, BeginShowAnimation, CancelInstallPS3, CheckForFrontEndError, ChildSceneOpened, GetTitleLabel, HandleInputKey, ImportMod, InstallPS3, OnCancelInstallPS3, OnCancelMessageClosed, OnImportModFinished, OnInstallMessageClosed, OnLoginError_Confirm, OnMainRegion_Show_UIAnimEnd, OnPageActivated, OnRetryPasswordDialog_Closed, OnTabPage_Hide_UIAnimEnd, OnTabPage_Show_UIAnimEnd, PostInitialize, PromptForPassword, SavePassword, SceneActivated, SetTitle, SetupButtonBar, UpdateModState, UpdatePS3InstallState
Inherited Functions from UTGame.UTUIScene
ActivateLevelEvent, AnimEnd, BeginHideAnimation, BeginShowAnimation, CheckCommunicationPrivilegeAndError, CheckContentPrivilegeAndError, CheckForAutoLogin, CheckLinkConnectionAndError, CheckLoginAndError, CheckNatTypeAndDisplayError, CheckOnlinePrivilegeAndError, CloseScene, ConditionallyCheckNumControllers, ConditionallyStartSplitscreen, ConsoleCommand, DeleteDemo, DisplayMessageBox, FindDataStore, FinishCloseScene, FinishOpenScene, GenerateDemoFileName, GetAccountInterface, GetBotTeamNameFromIndex, GetCommonOptionsURL, GetCurrentAudioDevice, GetGameInterface, GetInputBoxScene, GetMessageBoxScene, GetPawnOwner, GetPlayerControllerId, GetPlayerIndex, GetPlayerInterface, GetPlayerInterfaceEx, GetPlayerName, GetPlayerProfile, GetPlayerProfileFromPC, GetPossibleAudioDevices, GetPossibleScreenResolutions, GetPRIOwner, GetUTInteraction, GetUTPlayerOwner, GetWorldInfo, HideOnlineToast, IsBelowMinSpecs, IsControllerInput, IsGame, NotifyChildGameSessionEnded, NotifyGameSessionEnded, OnAnimationFinished, OnCurrentScene_HideAnimationEnded, OnLoginError_Confirm, OnLoginUI_LoginChange, OnLoginUI_LoginFailed, OnPendingCloseScene_HideAnimationEnded, OpenCmdLineURL, OpenScene, OpenSceneByName, PlaySound, SavePlayerProfile, SetAudioDeviceToUse, SetLanPlay, SetScreenResolution, SetupButtonBar, ShowLoginUI, ShowOnlineToast, ShowPlayerCard, StartDedicatedServer, StaticOpenScene, TrimWhitespace, TryCharacterUnlock, UpdateSplitscreenPlayers, ViewportDeProject, ViewportProject


Variables Detail

AvailableList Source code

var transient UIList AvailableList;
List of available maps.

DescriptionLabel Source code

var transient UILabel DescriptionLabel;
Label describing the currently selected map.

EnabledList Source code

var transient UIList EnabledList;
List of enabled maps.

LastFocused Source code

var transient UIList LastFocused;
The last focused UI List.

LoadedMapList Source code

var transient UTMapList LoadedMapList;
If the mapcycle has been loaded from a named maplist, reference it here

MenuDataStore Source code

var transient UTUIDataStore_MenuItems MenuDataStore;
Reference to the menu datastore

ShiftLeftImage Source code

var transient UIImage ShiftLeftImage;

ShiftRightImage Source code

var transient UIImage ShiftRightImage;
Arrow images.


Functions Detail

GenerateMapCycleList Source code

function GenerateMapCycleList ( out GameMapCycle Cycle) )
Converts the current map cycle to a string map names and stores them in the config saved array.

GenerateMapCycleListNew Source code

function GenerateMapCycleListNew ( out UTMapList MLObj) )
Added for maplist objects.

GetCurrentGameMode Source code

function name GetCurrentGameMode ( ) )

GetCurrentGameModeFull Source code

function name GetCurrentGameModeFull ( ) )

GrabOptions Source code

function string GrabOptions ( string InURL) )

HandleInputKey Source code

function bool HandleInputKey ( const out InputEventParameters EventParms ) )
Provides a hook for unrealscript to respond to input using actual input key names (i.e. Left, Tab, etc.) Called when an input key event is received which this widget responds to and is in the correct state to process. The keys and states widgets receive input for is managed through the UI editor's key binding dialog (F8). This delegate is called BEFORE kismet is given a chance to process the input.
@param EventParms information about the input event.
@return TRUE to indicate that this input key was processed; no further processing will occur on this input key event.

LoadMapCycle Source code

function LoadMapCycle ( ) )
Loads the map cycle for the current game mode and sets up the datastore's lists.

OnAccept Source code

function OnAccept ( ) )
The user has finished setting up their cycle and wants to save changes.

OnAvailableList_NotifyActiveStateChanged Source code

function OnAvailableList_NotifyActiveStateChanged ( UIScreenObject Sender, int PlayerIndex, UIState NewlyActiveState, optional UIState PreviouslyActiveState ) )
Callback for when the object's active state changes.

OnAvailableList_SubmitSelection Source code

function OnAvailableList_SubmitSelection ( UIList Sender, optional int PlayerIndex=GetBestPlayerIndex() ) )
Callback for when the user submits the selection on the available list.

OnAvailableList_ValueChanged Source code

function OnAvailableList_ValueChanged ( UIObject Sender, int PlayerIndex ) )
Callback for when the user selects a new item in the available list.

OnBack Source code

function OnBack ( ) )
The user wants to back out of the map cycle scene.

OnButtonBar_Accept Source code

function bool OnButtonBar_Accept ( UIScreenObject InButton, int PlayerIndex) )
Buttonbar Callbacks.

OnButtonBar_Back Source code

function bool OnButtonBar_Back ( UIScreenObject InButton, int PlayerIndex) )

OnButtonBar_ClearMaps Source code

function bool OnButtonBar_ClearMaps ( UIScreenObject InButton, int PlayerIndex) )

OnButtonBar_MoveMap Source code

function bool OnButtonBar_MoveMap ( UIScreenObject InButton, int PlayerIndex) )

OnButtonBar_ShiftDown Source code

function bool OnButtonBar_ShiftDown ( UIScreenObject InButton, int PlayerIndex) )

OnButtonBar_ShiftUp Source code

function bool OnButtonBar_ShiftUp ( UIScreenObject InButton, int PlayerIndex) )

OnClearMaps Source code

function OnClearMaps ( ) )
Clears the enabled map list.

OnEnabledList_NotifyActiveStateChanged Source code

function OnEnabledList_NotifyActiveStateChanged ( UIScreenObject Sender, int PlayerIndex, UIState NewlyActiveState, optional UIState PreviouslyActiveState ) )
Callback for when the object's active state changes.

OnEnabledList_SubmitSelection Source code

function OnEnabledList_SubmitSelection ( UIList Sender, optional int PlayerIndex=GetBestPlayerIndex() ) )
Callback for when the user submits the selection on the enabled list.

OnEnabledList_ValueChanged Source code

function OnEnabledList_ValueChanged ( UIObject Sender, int PlayerIndex ) )
Callback for when the user selects a new item in the enabled list.

OnMapListChanged Source code

function OnMapListChanged ( ) )
Called whenever one of the map lists changes.

OnMapList_RawInputKey Source code

function bool OnMapList_RawInputKey ( const out InputEventParameters EventParms ) )
Callback for the map lists, captures the accept button before the lists get to it.

OnMoveMap Source code

function OnMoveMap ( ) )
Callback for when the user tries to move a map from one list to another.

OnSelectedMapChanged Source code

function OnSelectedMapChanged ( ) )
Updates widgets when the currently selected map changes.

OnShiftMap Source code

function OnShiftMap ( bool bShiftUp) )
Shifts maps up and down in the map cycle.

PostInitialize Source code

event PostInitialize ( ) )
Post initialization event - Setup widget delegates.

SaveMapCycle Source code

function SaveMapCycle ( ) )
Transfers the current map cycle in the menu datastore to our array of config saved map cycles for each gamemode.

SetupButtonBar Source code

function SetupButtonBar ( ) )
Sets up the button bar for the parent scene.

StripOptions Source code

function string StripOptions ( coerce string InURL) )

UpdateDescriptionLabel Source code

function UpdateDescriptionLabel ( ) )
Updates the description label.


Defaultproperties

defaultproperties
{
   Begin Object Class=UIComp_Event Name=SceneEventComponent ObjName=SceneEventComponent Archetype=UIComp_Event'UTGame.Default__UTUIFrontEnd:SceneEventComponent'
      ObjectArchetype=UIComp_Event'UTGame.Default__UTUIFrontEnd:SceneEventComponent'
   End Object
   EventProvider=SceneEventComponent
   Name="Default__UTUIFrontEnd_MapCycle"
   ObjectArchetype=UTUIFrontEnd'UTGame.Default__UTUIFrontEnd'
}

Overview Package Class Source Class tree Glossary
previous class      next class frames      no frames
Creation time: sk 18-3-2018 10:00:58.853 - Created with UnCodeX