UE3:UTUIDataStore_MenuItems (UDK)

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

Package: 

UTGame

Implemented interfaces: 

UIListElementCellProvider, UIListElementProvider

This class in other games:

UT3

Inherited version of the game resource datastore that has UT specific dataproviders.

Properties

EnabledMutators

Type: array<int>

Array of enabled mutators, the available mutators list will not contain any of these mutators.

GameModeFilter

Type: int

Current game mode to filter by.

MapCycle

Type: array<int>

Array of maps, the available maps list will not contain any of these maps.

WeaponPriority

Type: array<int>

Priority listing of the weapons, index 0 being highest priority.

Default values

Property	Value
ElementProviderTypes[0]	Member Value ProviderClassName "UTGame.UTUIDataProvider_MainMenuItems" ProviderTag 'MainMenu'
ElementProviderTypes[1]	Member Value ProviderClassName "UTGame.UTUIDataProvider_MultiplayerMenuItem" ProviderTag 'MultiplayerMenu'
ElementProviderTypes[2]	Member Value ProviderClassName "UTGame.UTUIDataProvider_GameModeInfo" ProviderTag 'GameModes'
ElementProviderTypes[3]	Member Value ProviderClassName "UTGame.UTUIDataProvider_MapInfo" ProviderTag 'Maps'
ElementProviderTypes[4]	Member Value ProviderClassName "UTGame.UTUIDataProvider_MidGameMenu" ProviderTag 'MidGameMenu'
ElementProviderTypes[5]	Member Value ProviderClassName "UTGame.UTUIDataProvider_Mutator" ProviderTag 'Mutators'
ElementProviderTypes[6]	Member Value ProviderClassName "UTGame.UTUIDataProvider_Weapon" ProviderTag 'Weapons'
ElementProviderTypes[7]	Member Value ProviderClassName "UTGame.UTUIDataProvider_Weapon" ProviderTag 'DropDownWeapons'
Tag	'UTMenuItems'
WriteAccessType	ACCESS_WriteAll

Functions

Static native functions

GetAllResourceDataProviders

native static final function GetAllResourceDataProviders (class<UTUIResourceDataProvider> ProviderClass, out array<UTUIResourceDataProvider> Providers)

finds all UIResourceDataProvider objects defined in all .ini files in the game's config directory static and script exposed to allow access to map/mutator/gametype/weapon lists outside of the menus

Native functions

FindValueInProviderSet

native function int FindValueInProviderSet (name ProviderFieldName, name SearchTag, string SearchValue)

Attempts to find the index of a provider given a provider field name, a search tag, and a value to match.

Returns:

Returns the index of the provider or INDEX_NONE if the provider wasn't found.

GetProviderCount

native function int GetProviderCount (name FieldName) const

Overrides: UIDataStore_GameResource.GetProviderCount

Returns:

Returns the number of providers for a given field name.

GetProviderSet

native function bool GetProviderSet (name ProviderFieldName, out array<UTUIResourceDataProvider> OutProviders)

Attempts to retrieve all providers with the specified provider field name.

Parameters:

• ProviderFieldName - Name of the provider set to search for
• OutProviders - A set of providers with the given name

Returns:

TRUE if the set was found, FALSE otherwise.

GetValueFromProviderSet

native function bool GetValueFromProviderSet (name ProviderFieldName, name SearchTag, int ListIndex, out string OutValue)

Attempts to find the value of a provider given a provider cell field.

Returns:

Returns true if the value was found, false otherwise.

IsProviderFiltered

native function bool IsProviderFiltered (name FieldName, int ProviderIdx)

Returns:

Whether or not the specified provider is filtered or not.