UE3:UIDataStore_OnlinePlaylists (UDK)

Object >> UIRoot >> UIDataProvider >> UIDataStore >> UIDataStore_OnlinePlaylists

Package: 

Engine

Implemented interfaces: 

UIListElementProvider

Data store provides access to available playlist resources The data for each playlist is provided through a data provider and is specified in the .ini file for that data provider class type using the PerObjectConfig paradigm.

Constants

RANKEDPROVIDERTAG

Value: "PlaylistsRanked"

Constants used for accessing the data providers

UNRANKEDPROVIDERTAG

Value: "PlaylistsUnranked"

Properties

ProviderClass

Type: class<UIResourceDataProvider>

Modifiers: transient

Class reference for the above provider class name

ProviderClassName

Type: string

Modifiers: config

Name of provider class associated with this data store (uses them and all child classes)

RankedDataProviders

Type: array<UIResourceDataProvider>

Modifiers: const, private

Cached array of perobjectconfig data providers for playlists determined to be "ranked"

UnRankedDataProviders

Type: array<UIResourceDataProvider>

Modifiers: const, private

Cached array of perobjectconfig data providers for playlists determined to be "unranked"

Default values

Property	Value
Tag	'OnlinePlaylists'

Functions

Static functions

GetOnlinePlaylistProvider

static function OnlinePlaylistProvider GetOnlinePlaylistProvider (name ProviderTag, int PlaylistId, optional out int ProviderIndex)

Returns the OnlinePlaylistProvider with the corresponding PlaylistId

Native functions

FindProviderIndexByFieldValue

native final function int FindProviderIndexByFieldValue (name ProviderTag, name SearchField, out const UIRoot.UIProviderScriptFieldValue ValueToSearchFor) const

Searches for resource provider instance that has a field with a value that matches the value specified.

Parameters:

• ProviderTag - the name of the provider type; should match the ProviderTag value of an element in the ElementProviderTypes array.
• SearchField - the name of the field within the provider type to compare the value to; should be one of the elements retrieved from a call to GetResourceProviderFields.
• ValueToSearchFor - the field value to search for.

Returns:

the index of the resource provider instance that has the same value for SearchField as the value specified, or INDEX_NONE if the provider tag couldn't be resolved, none of the provider instances had a field with that name, or none of them had a field of that name with the value specified.

GetPlaylistProvider

native final function bool GetPlaylistProvider (name ProviderTag, int ProviderIndex, out UIResourceDataProvider out_Provider)

Searches for resource provider instance given its associated provider tag and an index within that subset

Parameters:

• ProviderTag - the name of the provider type; should match the ranked or unranked provider tag
• SearchField - the index of the provider within the provider subset specified by the ProviderTag
• out_Provider - the resource provider instance found

Returns:

true if the out_Provider has been found, false otherwise

GetProviderCount

native function int GetProviderCount (name ProviderTag) const

Get the number of UIResourceDataProvider instances associated with the specified tag.

Parameters:

• ProviderTag - the tag to find instances for; should match the ProviderTag value of an element in the ElementProviderTypes array.

Returns:

the number of instances registered for ProviderTag.

GetProviderFieldValue

native final function bool GetProviderFieldValue (name ProviderTag, name SearchField, int ProviderIndex, out UIRoot.UIProviderScriptFieldValue out_FieldValue) const

Get the value of a single field in a specific resource provider instance. Example: GetProviderFieldValue('PlaylistsRanked', 'PlaylistId', 2, FieldValue)

Parameters:

• ProviderTag - the name of the provider type; should match the ProviderTag value of an element in the ElementProviderTypes array.
• SearchField - the name of the field within the provider type to get the value for; should be one of the elements retrieved from a call to GetResourceProviderFields.
• ProviderIndex - the index [into the array of providers associated with the specified tag] of the instance to get the value from; should be one of the elements retrieved by calling GetResourceProviders().
• out_FieldValue - receives the value of the field

Returns:

TRUE if the field value was successfully retrieved from the provider. FALSE if the provider tag couldn't be resolved, the index was not a valid index for the list of providers, or the search field didn't exist in that provider.

GetResourceProviderFields

native final function bool GetResourceProviderFields (name ProviderTag, out array<name> ProviderFieldTags) const

Get the list of fields supported by the provider type specified.

Parameters:

• ProviderTag - the name of the provider type to get fields for; should match the ProviderTag value of an element in the ElementProviderTypes array. If the provider type is expanded (bExpandProviders=true), this tag should also contain the array index of the provider instance to use for retrieving the fields (this can usually be automated by calling GenerateProviderAccessTag)
• ProviderFieldTags - receives the list of tags supported by the provider specified.

Returns:

TRUE if the tag was resolved successfully and the list of tags was retrieved (doesn't guarantee that the provider array will contain any elements, though). FALSE if the data store couldn't resolve the ProviderTag.

GetResourceProviders

native final function bool GetResourceProviders (name ProviderTag, out array<UIResourceDataProvider> out_Providers) const

Get the UIResourceDataProvider instances associated with the tag.

Parameters:

• ProviderTag - the tag to find instances for; should match the ProviderTag value of an element in the ElementProviderTypes array.
• out_Providers - receives the list of provider instances. this array is always emptied first.

Returns:

the list of UIResourceDataProvider instances registered for ProviderTag.