Mostly Harmless

UE3:UIDataStorePublisher (UDK)

From Unreal Wiki, The Unreal Engine Documentation Site
Revision as of 11:47, 6 November 2009 by (Talk)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search
UDK Interface >> UIDataStoreSubscriber >> UIDataStorePublisher
Package: 
Engine
Known implementing classes:
UICalloutButton, UICheckbox, UIComboBox, UIContextMenu, UIEditBox, UIImage, UILabelButton, UIList, UINavigationList, UINumericEditBox, UINumericOptionList, UIObjectList, UIOptionList, UIOptionListBase, UIProgressBar, UISlider, UITabButton, UIToggleButton, UTUIButtonBarButton, UTUICollectionCheckBox, UTUIComboBox, UTUIEditBox, UTUIList, UTUINumericEditBox, UTUIOptionButton, UTUISlider
This interface in other games:
UT3

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

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

Native functions

SaveSubscriberValue

native function bool SaveSubscriberValue (out array<UIDataStoreout_BoundDataStores, optional int BindingIndex)

Resolves this subscriber's data store binding and publishes this subscriber's value to the appropriate data store.

Parameters:

  • out_BoundDataStores - contains the array of data stores that widgets have saved values to. Each widget that implements this method should add its resolved data store to this array after data values have been published. Once SaveSubscriberValue has been called on all widgets in a scene, OnCommit will be called on all data stores in this array.
  • 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 the value was successfully published to the data store.