Cogito, ergo sum

UE3:UIDataStoreSubscriber (UDK)

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
UDK Interface >> UIDataStoreSubscriber
Package: 
Engine
Known implementing classes:
UIFocusHint, UILabel, UITabPage, UTTabPage, UTTabPage_MidGame, UTUICharacterFactionMenuList, UTUIGameModeMenuList, UTUIIconMenuList, UTUIMapSelectionMenuList, UTUIMenuList, UTUIOptionList, UTUIPanel_SingleMap, UTUIStatsList, UTUITabPage_Chat, UTUITabPage_GameModeSelection, UTUITabPage_GameSettings, UTUITabPage_InGame, UTUITabPage_MapSelection, UTUITabPage_MidGameSettings, UTUITabPage_MOTD, UTUITabPage_Mutators, UTUITabPage_Options, UTUITabPage_Scoreboard, UTUITabPage_ServerBrowser, UTUITabPage_ServerFilter
Known direct subinterfaces:
UIDataStorePublisher
This interface in other games:
UT3

Provides an interface for working with objects which retrieve data using data stores.

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

Native functions[edit]

ClearBoundDataStores[edit]

native function ClearBoundDataStores ()

Notifies this subscriber to unbind itself from all bound data stores

GetBoundDataStores[edit]

native function GetBoundDataStores (out array<UIDataStoreout_BoundDataStores)

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[edit]

native function string GetDataStoreBinding (optional int BindingIndex) const

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[edit]

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

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.
  • bValuesInvalidated - TRUE if the data values were completely invalidated; suggest a full refresh rather than an update (i.e. in lists)
  • 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[edit]

native function bool RefreshSubscriberValue (optional int BindingIndex)

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

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:

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

SetDataStoreBinding[edit]

native function SetDataStoreBinding (string MarkupText, optional int BindingIndex)

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.