Difference between revisions of "UE3:UIDataStore GameResource (UDK)"

Revision as of 05:24, 17 January 2010

Object >> UIRoot >> UIDataProvider >> UIDataStore >> UIDataStore_GameResource

Package: 

Engine

Implemented interfaces: 

UIListElementProvider

Direct subclasses:

UIDataStore_MenuItems, UTUIDataStore_MenuItems, UTUIDataStore_Options

This class in other games:

UT3

Game resource data stores provide access to available game resources, such as the available gametypes, maps, or mutators The data for each type of game resource is provided through a data provider and is specified in the .ini file for that data provider class type using the PerObjectConfig paradigm.

Properties

ElementProviderTypes

Type: array<GameResourceDataProvider>

Modifiers: config

the list of data providers supported by this data store that correspond to list element data

Default value:

ListElementProviders

Type: Object.MultiMap_Mirror{TMultiMap<FName,class UUIResourceDataProvider*>}

Modifiers: const, private, native, transient

collection of list element provider instances that are associated with each ElementProviderType

Default values

Structs

GameResourceDataProvider

Modifiers: native

name ProviderTag 

the tag that is used to access this provider, i.e. Players, Teams, etc.

string ProviderClassName 

the name of the class associated with this data provider

bool bExpandProviders 

indicates that each provider instance should be displayed as an element in the list of tags, rather than

displaying the ProviderTag itself

class<UIResourceDataProvider> ProviderClass 

the UIDataProvider class that exposes the data for this data field tag

Native functions

FindProviderIndexByFieldValue

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.

FindProviderTypeIndex

Finds the index for the GameResourceDataProvider with a tag matching ProviderTag.

Returns:

the index into the ElementProviderTypes array for the GameResourceDataProvider element that has the tag specified, or INDEX_NONE if there are no elements of the ElementProviderTypes array that have that tag.

GenerateProviderAccessTag

Generates a tag containing the provider type with the name of an instance of that provider as the array delimiter.

Parameters:

• ProviderIndex - the index into the ElementProviderTypes array for the provider's type
• InstanceIndex - the index into that type's list of providers for the target instance

Returns:

a name containing the provider type name (i.e. the value of GameResourceDataProvider.ProviderTag) with the instance's name as the array delimiter.

GetProviderCount

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

Get the value of a single field in a specific resource provider instance. Example: GetProviderFieldValue('GameTypes', ClassName, 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

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

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.