UTGame.UTUIPanel_MapCycle

Extends

UTTabPage

Modifiers

dependson ( 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.UIObject
         |   
         +-- Engine.UIContainer
            |   
            +-- Engine.UITabPage
               |   
               +-- UTGame.UTTabPage
                  |   
                  +-- UTGame.UTUIPanel_MapCycle

Delegates Summary
		OnMapSelected ()

Functions Summary
		GenerateMapCycleList (out GameMapCycle Cycle))
		GenerateMapCycleListNew (out UTMapList MLObj))
	name	GetCurrentGameMode ()))
	name	GetCurrentGameModeFull ()))
	string	GetSelectedMap ()))
	string	GrabOptions (string InURL))
	bool	HandleInputKey (const out InputEventParameters EventParms ))
	bool	HandleRefreshSubscriberValue (UIObject Sender, int BindingIndex ))
		LoadMapCycle ()))
		OnAccept ()))
		OnAvailableList_SubmitSelection (UIList Sender, optional int PlayerIndex=GetBestPlayerIndex() ))
		OnAvailableList_ValueChanged (UIObject Sender, int PlayerIndex ))
	bool	OnButtonBar_Accept (UIScreenObject InButton, int PlayerIndex))
	bool	OnButtonBar_ClearMaps (UIScreenObject InButton, int PlayerIndex))
	bool	OnButtonBar_MoveMap (UIScreenObject InButton, int PlayerIndex))
	bool	OnButtonBar_ShiftDown (UIScreenObject InButton, int PlayerIndex))
	bool	OnButtonBar_ShiftUp (UIScreenObject InButton, int PlayerIndex))
		OnClearMaps ()))
		OnEnabledList_SubmitSelection (UIList Sender, optional int PlayerIndex=GetBestPlayerIndex() ))
		OnEnabledList_ValueChanged (UIObject Sender, int PlayerIndex ))
		OnList_NotifyActiveStateChanged (UIScreenObject Sender, int PlayerIndex, UIState NewlyActiveState, optional UIState PreviouslyActiveState ))
		OnMapListChanged ()))
	bool	OnMapList_RawInputKey (const out InputEventParameters EventParms ))
		OnMoveMap ()))
		OnSelectedMapChanged ()))
		OnShiftMap (bool bShiftUp))
		PostInitialize ()))
		SaveMapCycle ()))
		SelectBestList ()))
		SetupButtonBar (UTUIButtonBar ButtonBar))
	string	StripOptions (coerce string InURL))
		UpdateDescriptionLabel ()))

MANUAL_LIST_REFRESH_DATABINDING_INDEX Source code

AvailableList Source code

List of available maps.

DescriptionLabel Source code

Label describing the currently selected map.

EnabledList Source code

List of enabled maps.

LastFocused Source code

The last focused UI List.

ListBackground_Available Source code

ListBackground_Enabled Source code

LoadedMapList Source code

If the mapcycle has been loaded from a named maplist, reference it here

MenuDataStore Source code

Reference to the menu datastore

NumPlayersLabel Source code

Label for the number of players the maps supports.

ShiftDownButton Source code

ShiftDownLabel Source code

ShiftLeftImage Source code

ShiftRightImage Source code

Arrow images.

ShiftUpButton Source code

Reference to the shift up and down buttons.

ShiftUpLabel Source code

Shift up/down label callouts.

OnMapSelected Source code

Delegate for when the user selects a map on this page.

GenerateMapCycleList Source code

Converts the current map cycle to a string map names and stores them in the config saved array.

GenerateMapCycleListNew Source code

Added for maplist objects.

GetCurrentGameMode Source code

GetCurrentGameModeFull Source code

GetSelectedMap Source code

@return Returns the first currently selected map.

GrabOptions Source code

HandleInputKey Source code

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.

HandleRefreshSubscriberValue Source code

Called when this widget receives a call to RefreshSubscriberValue.
@param BindingIndex optional parameter for indicating which data store binding is being refreshed, for those objects which have multiple data store bindings. How this parameter is used is up to the class which implements this interface, but typically the "primary" data store will be index 0, while values greater than FIRST_DEFAULT_DATABINDING_INDEX correspond to tooltips and context menus.
@return TRUE to indicate that this widget is going to refresh its value manually.

LoadMapCycle Source code

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

OnAccept Source code

The user has finished setting up their cycle and wants to save changes.

OnAvailableList_SubmitSelection Source code

Callback for when the user submits the selection on the available list.

OnAvailableList_ValueChanged Source code

Callback for when the user selects a new item in the available list.

OnButtonBar_Accept Source code

Buttonbar Callbacks.

OnButtonBar_ClearMaps Source code

OnButtonBar_MoveMap Source code

OnButtonBar_ShiftDown Source code

OnButtonBar_ShiftUp Source code

OnClearMaps Source code

Clears the enabled map list.

OnEnabledList_SubmitSelection Source code

Callback for when the user submits the selection on the enabled list.

OnEnabledList_ValueChanged Source code

Callback for when the user selects a new item in the enabled list.

OnList_NotifyActiveStateChanged Source code

Callback for when the object's active state changes.

OnMapListChanged Source code

Called whenever one of the map lists changes.

OnMapList_RawInputKey Source code

Callback for the map lists, captures the accept button before the lists get to it.

OnMoveMap Source code

Callback for when the user tries to move a map from one list to another.

OnSelectedMapChanged Source code

Updates widgets when the currently selected map changes.

OnShiftMap Source code

Shifts maps up and down in the map cycle.

PostInitialize Source code

Post initialization event - Setup widget delegates.

SaveMapCycle Source code

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

SelectBestList Source code

Selects the best list depending on which list has currently available maps.

SetupButtonBar Source code

Sets up the button bar for the parent scene.

StripOptions Source code

UpdateDescriptionLabel Source code

Updates the description label.

defaultproperties
{
   Begin Object Class=UIComp_Event Name=WidgetEventComponent ObjName=WidgetEventComponent Archetype=UIComp_Event'UTGame.Default__UTTabPage:WidgetEventComponent'
      ObjectArchetype=UIComp_Event'UTGame.Default__UTTabPage:WidgetEventComponent'
   End Object
   EventProvider=WidgetEventComponent
   Name="Default__UTUIPanel_MapCycle"
   ObjectArchetype=UTTabPage'UTGame.Default__UTTabPage'
}