There is no spoon

UE3:UTUIDataStore_MenuItems (UDK)

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
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[edit]

EnabledMutators[edit]

Type: array<int>

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

GameModeFilter[edit]

Type: int

Current game mode to filter by.

MapCycle[edit]

Type: array<int>

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

WeaponPriority[edit]

Type: array<int>

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

Default values[edit]

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[edit]

Static native functions[edit]

GetAllResourceDataProviders[edit]

native static final function GetAllResourceDataProviders (class<UTUIResourceDataProviderProviderClass, out array<UTUIResourceDataProviderProviders)

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[edit]

FindValueInProviderSet[edit]

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[edit]

native function int GetProviderCount (name FieldName) const

Overrides: UIDataStore_GameResource.GetProviderCount

Returns:

Returns the number of providers for a given field name.

GetProviderSet[edit]

native function bool GetProviderSet (name ProviderFieldName, out array<UTUIResourceDataProviderOutProviders)

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[edit]

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[edit]

native function bool IsProviderFiltered (name FieldName, int ProviderIdx)

Returns:

Whether or not the specified provider is filtered or not.