Engine.UIDataStore_GameResource

Extends

UIDataStore

Modifiers

native ( inherit ) implements ( UIListElementProvider ) Config ( Game )

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. Copyright 1998-2011 Epic Games, Inc. All Rights Reserved.

Core.Object
|   
+-- Engine.UIRoot
   |   
   +-- Engine.UIDataProvider
      |   
      +-- Engine.UIDataStore
         |   
         +-- Engine.UIDataStore_GameResource

Direct Known Subclasses:

UDKUIDataStore_MenuItems, UDKUIDataStore_Options, UIDataStore_MenuItems

Functions Summary
	int	FindProviderIndexByFieldValue (name ProviderTag, name SearchField, out const UIProviderScriptFieldValue ValueToSearchFor ) con)
	int	FindProviderTypeIndex (name ProviderTag ) con)
	name	GenerateProviderAccessTag (int ProviderIndex, int InstanceIndex ) con)
	int	GetProviderCount (name ProviderTag ) con)
	bool	GetProviderFieldValue (name ProviderTag, name SearchField, int ProviderIndex, out UIProviderScriptFieldValue out_FieldValue ) con)
	bool	GetResourceProviderFields (name ProviderTag, out array ProviderFieldTags ) con)
	bool	GetResourceProviders (name ProviderTag, out array out_Providers ) con)

ElementProviderTypes Source code

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

ListElementProviders Source code

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

GameResourceDataProvider Source code

bExpandProviders:

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

ProviderClass:

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

ProviderClassName:

the name of the class associated with this data provider

ProviderTag:

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

FindProviderIndexByFieldValue Source code

Searches for resource provider instance that has a field with a value that matches the value specified.
@param ProviderTag the name of the provider type; should match the ProviderTag value of an element in the ElementProviderTypes array.
@param 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.
@param ValueToSearchFor the field value to search for.
@return 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 Source code

Finds the index for the GameResourceDataProvider with a tag matching ProviderTag.
@return 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 Source code

Generates a tag containing the provider type with the name of an instance of that provider as the array delimiter.
@param ProviderIndex the index into the ElementProviderTypes array for the provider's type
@param InstanceIndex the index into that type's list of providers for the target instance
@return a name containing the provider type name (i.e. the value of GameResourceDataProvider.ProviderTag) with the instance's name as the array delimiter.

GetProviderCount Source code

Get the number of UIResourceDataProvider instances associated with the specified tag.
@param ProviderTag the tag to find instances for; should match the ProviderTag value of an element in the ElementProviderTypes array.
@return the number of instances registered for ProviderTag.

GetProviderFieldValue Source code

Get the value of a single field in a specific resource provider instance. Example: GetProviderFieldValue('GameTypes', ClassName, 2, FieldValue)
@param ProviderTag the name of the provider type; should match the ProviderTag value of an element in the ElementProviderTypes array.
@param 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.
@param 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().
@param out_FieldValue receives the value of the field
@return 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 Source code

Get the list of fields supported by the provider type specified.
@param 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)
@param ProviderFieldTags receives the list of tags supported by the provider specified.
@return 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 Source code

Get the UIResourceDataProvider instances associated with the tag.
@param ProviderTag the tag to find instances for; should match the ProviderTag value of an element in the ElementProviderTypes array.
@param out_Providers receives the list of provider instances. this array is always emptied first.
@return the list of UIResourceDataProvider instances registered for ProviderTag.

defaultproperties
{
	Tag=GameResources
}