UE3:UIDynamicDataProvider (UDK)

Object >> UIRoot >> UIDataProvider >> UIPropertyDataProvider >> UIDynamicDataProvider

Package: 

Engine

Implemented interfaces: 

UIListElementCellProvider

Direct subclasses:

GameInfoDataProvider, InventoryDataProvider, PickupDataProvider, PlayerDataProvider, TeamDataProvider, UIDataProvider_Settings

This class in other games:

UT3

Provides data about a particular instance of an actor in the game.

Properties

DataClass

Type: Class

Modifiers: const

The metaclass for this data provider. Each instance of this class (including instances of child classes) will have a data provider that tells the UI which properties to provide for this class. Classes indicate which properties are available for use by dynamic data stores by marking the property with a keyword.

DataSource

Type: Object

Modifiers: const, transient, protected

The object that this data provider is presenting data for. Set by calling BindProviderInstance.

Functions

Native functions

BindProviderInstance

native final function bool BindProviderInstance (Object DataSourceInstance)

Associates this data provider with the specified instance.

Parameters:

• DataSourceInstance - a pointer to the object instance that this data provider should present data for. DataSourceInstance must be of type DataClass.

Returns:

TRUE if the instance specified was successfully associated with this data provider. FALSE if the object specified wasn't of the correct type or was otherwise invalid.

UnbindProviderInstance

native final function bool UnbindProviderInstance ()

Clears the instance associated with this data provider.

Returns:

TRUE if the instance reference was successfully cleared.

Events

IsValidDataSourceClass

event bool IsValidDataSourceClass (Class PotentialDataSourceClass)

Script hook for preventing a particular child of DataClass from being represented by this dynamic data provider.

Parameters:

• PotentialDataSourceClass - a child class of DataClass that is being considered as a candidate for binding by this provider.

Returns:

return FALSE to prevent PotentialDataSourceClass's properties from being added to the UI editor's list of bindable properties for this data provider; also prevents any instances of PotentialDataSourceClass from binding to this provider at runtime.

ProviderInstanceBound

event ProviderInstanceBound (Object DataSourceInstance)

Called once BindProviderInstance has successfully verified that DataSourceInstance is of the correct type. Child classes can override this function to handle storing the reference, for example.

ProviderInstanceUnbound

event ProviderInstanceUnbound (Object DataSourceInstance)

Called immediately after this data provider's DataSource is disassociated from this data provider.

Other instance functions

CleanupDataProvider

function bool CleanupDataProvider ()

Allows the data provider to clear any references that would interfere with garbage collection.

Returns:

TRUE if the instance reference was successfully cleared.

GetDataSource

final function Object GetDataSource ()

Returns a reference to the data source associated with this data provider.