UE3:UTUIMenuList (UT3)

Object >> UIRoot >> UIScreenObject >> UIObject >> UTUI_Widget >> UTDrawPanel >> UTSimpleList >> UTUIMenuList

Package: 

UTGame

Implemented interfaces: 

UIDataStoreSubscriber

Direct subclasses:

UTUICharacterCustomizationList, UTUIIconMenuList, UTUICharacterPartMenuList

This class in other games:

UDK

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

List widget used in many of the UT menus that renders using z-ordering to simulate a 'circular' list.

Properties

Property group 'Data'

DataSource

Type: UIRoot.UIDataStoreBinding

The data store that this list is bound to

Default value:

Member	Value
RequiredFieldType	DATATYPE_Collection

SelectedIndexDataSource

Type: UIRoot.UIDataStoreBinding

Modifiers: editconst, private

The data source that this list will get and save its currently selected indices from.

Default value:

Member	Value
RequiredFieldType	INVALID

Internal variables

bIsRotating

Type: bool

Whether or not we are currently animating.

DataProvider

Type: UIListElementProvider

Modifiers: const, transient

the list element provider referenced by DataSource

MenuListItems

Type: array<int>

Modifiers: transient

Current items of the list, these index into the list dataprovider.

StartRotationTime

Type: float

Time we started rotating the items in this widget.

Subobjects

WidgetEventComponent

Class: Engine.UIComp_Event

Inherits from: UTSimpleList.WidgetEventComponent

No new values.

Delegates

OnSubmitSelection

delegate OnSubmitSelection (UIObject Sender, optional int PlayerIndex)

Called when the user presses Enter (or any other action bound to UIKey_SubmitListSelection) while this list has focus.

Parameters:

• Sender - the list that is submitting the selection

Functions

Static native functions

FindCellFieldString

native static final function int FindCellFieldString (UIObject InObject, name InCellTag, string FindValue, optional bool bCaseSensitive)

returns the first list index the has the specified value for the specified cell, or INDEX_NONE if it couldn't be found

GetCellFieldValue

static function native bool GetCellFieldValue (UIObject InList, name InCellTag, int InListIndex, out UIRoot.UIProviderFieldValue OutValue)

Gets the cell field value for a specified list and list index.

Parameters:

• InList - List to get the cell field value for.
• InCellTag - Tag to get the value for.
• InListIndex - Index to get the value for.
• OutValue - Storage variable for the final value.

Other static functions

GetCellFieldString

static final function bool GetCellFieldString (UIObject InList, name InCellTag, int InListIndex, out string OutValue)

Gets the cell field value for a specified list and list index.

Parameters:

• InList - List to get the cell field value for.
• InCellTag - Tag to get the value for.
• InListIndex - Index to get the value for.
• OutValue - Storage variable for the final value.

Native functions

ClearBoundDataStores

native final virtual function ClearBoundDataStores ()

Specified by: UIDataStoreSubscriber.ClearBoundDataStores

Notifies this subscriber to unbind itself from all bound data stores

GetBoundDataStores

native final virtual function GetBoundDataStores (out array<UIDataStore> out_BoundDataStores)

Specified by: UIDataStoreSubscriber.GetBoundDataStores

Retrieves the list of data stores bound by this subscriber.

Parameters:

• out_BoundDataStores - receives the array of data stores that subscriber is bound to.

GetDataStoreBinding

native final virtual function string GetDataStoreBinding (optional int BindingIndex) const

Specified by: UIDataStoreSubscriber.GetDataStoreBinding

Retrieves the markup string corresponding to the data store that this object is bound to.

Parameters:

• BindingIndex - optional parameter for indicating which data store binding is being requested 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.

Returns:

a datastore markup string which resolves to the datastore field that this object is bound to, in the format: <DataStoreTag:DataFieldTag>

NotifyDataStoreValueUpdated

native function NotifyDataStoreValueUpdated (UIDataStore SourceDataStore, bool bValuesInvalidated, name PropertyTag, UIDataProvider SourceProvider, int ArrayIndex)

Specified by: UIDataStoreSubscriber.NotifyDataStoreValueUpdated

Handler for the UIDataStore.OnDataStoreValueUpdated delegate. Used by data stores to indicate that some data provided by the data has changed. Subscribers should use this function to refresh any data store values being displayed with the updated value. notify subscribers when they should refresh their values from this data store.

Parameters:

• SourceDataStore - the data store that generated the refresh notification; useful for subscribers with multiple data store bindings, to tell which data store sent the notification.
• PropertyTag - the tag associated with the data field that was updated; Subscribers can use this tag to determine whether there is any need to refresh their data values.
• SourceProvider - for data stores which contain nested providers, the provider that contains the data which changed.
• ArrayIndex - for collection fields, indicates which element was changed. value of INDEX_NONE indicates not an array or that the entire array was updated.

RefreshSubscriberValue

native final virtual function bool RefreshSubscriberValue (optional int BindingIndex)

Specified by: UIDataStoreSubscriber.RefreshSubscriberValue

Resolves this subscriber's data store binding and updates the subscriber with the current value from the data store.

Returns:

TRUE if this subscriber successfully resolved and applied the updated value.

RegenerateOptions

native function RegenerateOptions ()

Regenerates the list of options for this menu list.

SetDataStoreBinding

native final virtual function SetDataStoreBinding (string MarkupText, optional int BindingIndex)

Specified by: UIDataStoreSubscriber.SetDataStoreBinding

Sets the data store binding for this object to the text specified.

Parameters:

• MarkupText - a markup string which resolves to data exposed by a data store. The expected format is: <DataStoreTag:DataFieldTag>
• BindingIndex - optional parameter for indicating which data store binding is being requested 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.

Events

PostInitialize

event PostInitialize ()

Overrides: UTSimpleList.PostInitialize

Setup the input system

SelectItem

event SelectItem (int NewSelection)

Overrides: UTSimpleList.SelectItem

Selects an item

Other instance functions

GetCurrentItem

function int GetCurrentItem ()

Returns:

Returns the currently selected item.

ItemChosen

function ItemChosen (int PlayerIndex)

Overrides: UTSimpleList.ItemChosen

Callback for when the user has picked a list item.

SetIndex

function SetIndex (int NewIndex)

Sets the currently selected item.