UE3:UIDataStore_MenuItems (UDK)

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

Package:

Engine

Implemented interfaces:

UIListElementProvider

This data store provides information for automatically generating lists of widgets given a collection of metadata provided by the UIDataProvider_MenuItem class.

Copyright 1998-2009 Epic Games, Inc. All Rights Reserved

Properties

CurrentGameSettingsTag

Type: name

Modifiers: const

the tag used to retrieve the menu items for the gametype options of the OnlineGameSettings datastore's selected game configuration.

Default value: 'CurrentGameSettings'

DynamicProviders

Type: array<UIDataProvider_MenuItem>

Modifiers: transient

Array of dynamically created providers.

OptionProviders

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

Modifiers: const, private, native, transient

collection of providers per part type.

Default values

Property	Value
ElementProviderTypes[0]	No value definitions.
Tag	'MenuItems'

Functions

Native functions

AppendToSet

native function AppendToSet (name SetName, int NumOptions)

Appends N amount of providers to the specified set.

Parameters:

• SetName - Set to append to
• NumOptions - Number of options to append

ClearSet

native function ClearSet (name SetName)

Clears all options in the specified set.

Parameters:

• SetName - Set to clear

GetSet

native function GetSet (name SetName, out array<UIDataProvider_MenuItem> OutProviders)

Retrieves a set of option providers.

Parameters:

• SetName - Set to retrieve
• OutProviders - Storage array for resulting providers.

Events

Registered

event Registered (LocalPlayer PlayerOwner)

Overrides: UIDataStore.Registered

Called when this data store is added to the data store manager's list of active data stores.

Parameters:

• PlayerOwner - the player that will be associated with this DataStore. Only relevant if this data store is associated with a particular player; NULL if this is a global data store.

Unregistered

event Unregistered (LocalPlayer PlayerOwner)

Overrides: UIDataStore.Unregistered

Called when this data store is removed from the data store manager's list of active data stores.

Parameters:

• PlayerOwner - the player that will be associated with this DataStore. Only relevant if this data store is associated with a particular player; NULL if this is a global data store.

Other instance functions

OnGameSettingsChanged

function OnGameSettingsChanged (UIDataProvider SourceProvider, optional name PropTag)

Handler for the OnlineGameSettings data store's OnDataProviderPropertyChange delegate. When the selected gametype is changed, updates the current game option set.

Parameters:

• SourceProvider - the data provider that generated the notification
• PropTag - the property that changed