Difference between revisions of "UE3:UTUIStatsList (UDK)"

Revision as of 11:47, 6 November 2009 (edit) (Talk)		Revision as of 05:24, 17 January 2010 (edit) (undo) (Talk) Newer edit →
Line 67:		Line 67:
	'''[[Structs#Modifiers|Modifiers]]:''' native		'''[[Structs#Modifiers|Modifiers]]:''' native
−	<!-- enter struct description -->	+	Info about an option we have generated.
	; [[name]] DataTag : <!-- enter variable description -->		; [[name]] DataTag : <!-- enter variable description -->
	; {{cl|UILabel}} KeyObj : <!-- enter variable description -->		; {{cl|UILabel}} KeyObj : <!-- enter variable description -->

---

Revision as of 05:24, 17 January 2010

Package: 

UTGame

Implemented interfaces: 

UIDataStoreSubscriber

This class in other games:

UT3

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.

Stats widget, auto generates labels for all of the fields in the bound datasource.

Properties

Property group 'Data'

DataSource

Type: UIRoot.UIDataStoreBinding

The data store that this list is bound to

Default value:

Member	Value
RequiredFieldType	DATATYPE_Collection

Internal variables

DataProvider

Type: UIListElementProvider

Modifiers: const, transient

the list element provider referenced by DataSource

GeneratedObjects

Type: array<GeneratedStatisticInfo>

Modifiers: transient

List of auto-generated objects, anything in this array will be removed from the children's array before presave.

Default values

Property	Value
ScrollbarHorizontal	UIScrollbar'UTGame.Default__UTUIStatsList:HorzScrollbarTemplate'
ScrollbarVertical	UIScrollbar'UTGame.Default__UTUIStatsList:VertScrollbarTemplate'

Subobjects

WidgetEventComponent

Class: Engine.UIComp_Event

Inherits from: UIScrollFrame.WidgetEventComponent

No new values.

Structs

GeneratedStatisticInfo

Modifiers: native

Info about an option we have generated.

name DataTag 

UILabel KeyObj 

UILabel ValueObj 

Functions

Native functions

ClearBoundDataStores

Specified by: UIDataStoreSubscriber.ClearBoundDataStores

Notifies this subscriber to unbind itself from all bound data stores

GetBoundDataStores

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

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

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

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

Generates widgets for all of the options.

RepositionOptions

Repositions all of the visible options.

SetDataStoreBinding

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.

SetStatsIndex

Sets which result row to get stats values from and then retrieves the stats values.

Events

PostInitialize

Overrides: UIScreenObject.PostInitialize

Post initialize, binds callbacks for all of the generated options.