UE3:UTUIPanel MapCycle (UT3): Difference between revisions

From Unreal Wiki, The Unreal Engine Documentation Site
Auto-generated page
 
m updated members
 
Line 11: Line 11:
}}
}}
{{autogenerated}}
{{autogenerated}}
Copyright 1998-2007 Epic Games, Inc. All Rights Reserved.
Copyright 1998-2008 Epic Games, Inc. All Rights Reserved.


UI scene that allows the user to setup a map cycle.
UI scene that allows the user to setup a map cycle.
Line 63: Line 63:


<!-- enter variable description -->
<!-- enter variable description -->
====LoadedMapList====
'''Type:''' {{cl|UTMapList}}
'''[[Variables#Modifiers|Modifiers]]:''' transient
If the mapcycle has been loaded from a named maplist, reference it here


====MenuDataStore====
====MenuDataStore====
Line 144: Line 151:


===Other instance functions===
===Other instance functions===
====GenerateMapCycleList====
See {{cl|UTUIPanel_MapCycle instance functions}}.
{{code|function '''GenerateMapCycleList''' (out&nbsp;{{tl|GameMapCycle|UTGame}}&nbsp;'''Cycle''')}}
 
Converts the current map cycle to a string map names and stores them in the config saved array.
 
====GetCurrentGameMode====
{{code|function [[name]]&nbsp;'''GetCurrentGameMode''' ()}}
 
<!-- enter function description -->
 
====GetSelectedMap====
{{code|function [[string]]&nbsp;'''GetSelectedMap''' ()}}
 
'''Returns:'''
:Returns the first currently selected map.
 
====HandleInputKey====
{{code|function [[bool]]&nbsp;'''HandleInputKey''' (const&nbsp;out&nbsp;{{tl|InputEventParameters|UIRoot|structs}}&nbsp;'''EventParms''')}}
 
'''Overrides:''' {{tl|HandleInputKey|UTTabPage}}
 
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.
 
'''Parameters:'''
* ''EventParms'' - information about the input event.
 
'''Returns:'''
:TRUE to indicate that this input key was processed; no further processing will occur on this input key event.
 
====HandleRefreshSubscriberValue====
{{code|function [[bool]]&nbsp;'''HandleRefreshSubscriberValue''' ({{cl|UIObject}}&nbsp;'''Sender''', [[int]]&nbsp;'''BindingIndex''')}}
 
Called when this widget receives a call to RefreshSubscriberValue.
 
'''Parameters:'''
* ''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.
 
'''Returns:'''
:TRUE to indicate that this widget is going to refresh its value manually.
 
====LoadMapCycle====
{{code|function '''LoadMapCycle''' ()}}
 
Loads the map cycle for the current game mode and sets up the datastore's lists.
 
====OnAccept====
{{code|function '''OnAccept''' ()}}
 
The user has finished setting up their cycle and wants to save changes.
 
====OnAvailableList_SubmitSelection====
{{code|function '''OnAvailableList_SubmitSelection''' ({{cl|UIList}}&nbsp;'''Sender''', optional&nbsp;[[int]]&nbsp;'''PlayerIndex''')}}
 
Callback for when the user submits the selection on the available list.
 
====OnAvailableList_ValueChanged====
{{code|function '''OnAvailableList_ValueChanged''' ({{cl|UIObject}}&nbsp;'''Sender''', [[int]]&nbsp;'''PlayerIndex''')}}
 
Callback for when the user selects a new item in the available list.
 
====OnButtonBar_Accept====
{{code|function [[bool]]&nbsp;'''OnButtonBar_Accept''' ({{cl|UIScreenObject}}&nbsp;'''InButton''', [[int]]&nbsp;'''PlayerIndex''')}}
 
Buttonbar Callbacks.
 
====OnButtonBar_ClearMaps====
{{code|function [[bool]]&nbsp;'''OnButtonBar_ClearMaps''' ({{cl|UIScreenObject}}&nbsp;'''InButton''', [[int]]&nbsp;'''PlayerIndex''')}}
 
<!-- enter function description -->
 
====OnButtonBar_MoveMap====
{{code|function [[bool]]&nbsp;'''OnButtonBar_MoveMap''' ({{cl|UIScreenObject}}&nbsp;'''InButton''', [[int]]&nbsp;'''PlayerIndex''')}}
 
<!-- enter function description -->
 
====OnButtonBar_ShiftDown====
{{code|function [[bool]]&nbsp;'''OnButtonBar_ShiftDown''' ({{cl|UIScreenObject}}&nbsp;'''InButton''', [[int]]&nbsp;'''PlayerIndex''')}}
 
<!-- enter function description -->
 
====OnButtonBar_ShiftUp====
{{code|function [[bool]]&nbsp;'''OnButtonBar_ShiftUp''' ({{cl|UIScreenObject}}&nbsp;'''InButton''', [[int]]&nbsp;'''PlayerIndex''')}}
 
<!-- enter function description -->
 
====OnClearMaps====
{{code|function '''OnClearMaps''' ()}}
 
Clears the enabled map list.
 
====OnEnabledList_SubmitSelection====
{{code|function '''OnEnabledList_SubmitSelection''' ({{cl|UIList}}&nbsp;'''Sender''', optional&nbsp;[[int]]&nbsp;'''PlayerIndex''')}}
 
Callback for when the user submits the selection on the enabled list.
 
====OnEnabledList_ValueChanged====
{{code|function '''OnEnabledList_ValueChanged''' ({{cl|UIObject}}&nbsp;'''Sender''', [[int]]&nbsp;'''PlayerIndex''')}}
 
Callback for when the user selects a new item in the enabled list.
 
====OnList_NotifyActiveStateChanged====
{{code|function '''OnList_NotifyActiveStateChanged''' ({{cl|UIScreenObject}}&nbsp;'''Sender''', [[int]]&nbsp;'''PlayerIndex''', {{cl|UIState}}&nbsp;'''NewlyActiveState''', optional&nbsp;{{cl|UIState}}&nbsp;'''PreviouslyActiveState''')}}
 
Callback for when the object's active state changes.
 
====OnMapList_RawInputKey====
{{code|function [[bool]]&nbsp;'''OnMapList_RawInputKey''' (const&nbsp;out&nbsp;{{tl|InputEventParameters|UIRoot|structs}}&nbsp;'''EventParms''')}}
 
Callback for the map lists, captures the accept button before the lists get to it.
 
====OnMapListChanged====
{{code|function '''OnMapListChanged''' ()}}
 
Called whenever one of the map lists changes.
 
====OnMoveMap====
{{code|function '''OnMoveMap''' ()}}
 
Callback for when the user tries to move a map from one list to another.
 
====OnSelectedMapChanged====
{{code|function '''OnSelectedMapChanged''' ()}}
 
Updates widgets when the currently selected map changes.
 
====OnShiftMap====
{{code|function '''OnShiftMap''' ([[bool]]&nbsp;'''bShiftUp''')}}
 
Shifts maps up and down in the map cycle.
 
====SaveMapCycle====
{{code|function '''SaveMapCycle''' ()}}
 
Transfers the current map cycle in the menu datastore to our array of config saved map cycles for each gamemode.
 
====SelectBestList====
{{code|function '''SelectBestList''' ()}}
 
Selects the best list depending on which list has currently available maps.
 
====SetupButtonBar====
{{code|function '''SetupButtonBar''' ({{cl|UTUIButtonBar}}&nbsp;'''ButtonBar''')}}
 
'''Overrides:''' {{tl|SetupButtonBar|UTTabPage}}
 
Sets up the button bar for the parent scene.
 
====UpdateDescriptionLabel====
{{code|function '''UpdateDescriptionLabel''' ()}}
 
Updates the description label.

Latest revision as of 06:23, 16 August 2009

UT3 Object >> UIRoot >> UIScreenObject >> UIObject >> UIContainer >> UITabPage >> UTTabPage >> UTUIPanel_MapCycle
Package:
UTGame
Implemented interfaces:
UIDataStoreSubscriber
This is an auto-generated page and may need human attention.
Please remove the {{autogenerated}} tag if the page seems reasonably complete or replace it with the {{expand}} tag if the page is not yet complete.

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

UI scene that allows the user to setup a map cycle.

Constants[edit]

MANUAL_LIST_REFRESH_DATABINDING_INDEX[edit]

Value: 50


Properties[edit]

AvailableList[edit]

Type: UIList

Modifiers: transient

List of available maps.

DescriptionLabel[edit]

Type: UILabel

Modifiers: transient

Label describing the currently selected map.

EnabledList[edit]

Type: UIList

Modifiers: transient

List of enabled maps.

LastFocused[edit]

Type: UIList

Modifiers: transient

The last focused UI List.

ListBackground_Available[edit]

Type: UIImage

Modifiers: transient


ListBackground_Enabled[edit]

Type: UIImage

Modifiers: transient


LoadedMapList[edit]

Type: UTMapList

Modifiers: transient

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

MenuDataStore[edit]

Type: UTUIDataStore_MenuItems

Modifiers: transient

Reference to the menu datastore

NumPlayersLabel[edit]

Type: UILabel

Modifiers: transient

Label for the number of players the maps supports.

ShiftDownButton[edit]

Type: UIButton

Modifiers: transient


ShiftDownLabel[edit]

Type: UILabel

Modifiers: transient


ShiftLeftImage[edit]

Type: UIImage

Modifiers: transient


ShiftRightImage[edit]

Type: UIImage

Modifiers: transient

Arrow images.

ShiftUpButton[edit]

Type: UIButton

Modifiers: transient

Reference to the shift up and down buttons.

ShiftUpLabel[edit]

Type: UILabel

Modifiers: transient

Shift up/down label callouts.

Subobjects[edit]

WidgetEventComponent[edit]

Class: Engine.UIComp_Event

Inherits from: UTTabPage.WidgetEventComponent

No new values.

Delegates[edit]

OnMapSelected[edit]

delegate OnMapSelected ()

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

Functions[edit]

Events[edit]

PostInitialize[edit]

event PostInitialize ()

Overrides: UIScreenObject.PostInitialize

Post initialization event - Setup widget delegates.

Other instance functions[edit]

See UTUIPanel_MapCycle instance functions.

Retrieved from "https://wiki.beyondunreal.com/index.php?title=UE3:UTUIPanel_MapCycle_(UT3)&oldid=35263"