UE3:UIDataProvider_MenuItem (UDK)

From Unreal Wiki, The Unreal Engine Documentation Site
UDK Object >> UIRoot >> UIDataProvider >> UIPropertyDataProvider >> UIResourceDataProvider >> UIDataProvider_MenuItem
Package:
Engine
Implemented interfaces:
UIListElementCellProvider, UIListElementProvider

Provides all required information for dynmically generating a widget to be placed into a scene.

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

Properties

Property group 'UIDataProvider_MenuItem'

bSearchAllInis

Type: bool

whether to search all .inis for valid resource provider instances instead of just the our specified config file this is used for lists that need to support additions via extra files, i.e. mods

Internal variables

bEditableCombo

Type: bool

Modifiers: config

Whether or not the options presented to the user are the only options they can choose from, used on PC only for setting whether combobox edit boxes are read only or not.

bKeyboardOrMouseOption

Type: bool

Modifiers: config

Whether the option is a keyboard or mouse option.

bNumericCombo

Type: bool

Modifiers: config

Whether or not the combobox is numeric.

bOfflineOnly

Type: bool

Modifiers: config

Whether the option is a offline only option or not.

bOnlineOnly

Type: bool

Modifiers: config

Whether the option is a online only option or not.

bRemoveOn360

Type: bool

Modifiers: config

Options to remove certain menu items on a per platform basis.

bRemoveOnPC

Type: bool

Modifiers: config


bRemoveOnPS3

Type: bool

Modifiers: config


CustomFriendlyName

Type: string

Script settable friendly name.

DataStoreMarkup

Type: string

Modifiers: config

Markup for the option

Description

Type: string

Modifiers: config, localized

Localized description of the option

DescriptionMarkup

Type: string

Modifiers: config

Markup for the description for the option

EditboxAllowedChars

Type: UIRoot.EEditBoxCharacterSet

Modifiers: config

the allowed character set for editboxes

EditBoxMaxLength

Type: int

Modifiers: config

Maximum length of the editbox property.

FriendlyName

Type: string

Modifiers: config, localized

Friendly displayable name to the player.

IniName

Type: string

Modifiers: const

the .ini file that this instance was created from, if not the class default .ini (for bSearchAllInis classes)

OptionSet

Type: array<name>

Modifiers: config

Name of the option set that this option belongs to.

OptionType

Type: EMenuOptionType

Modifiers: config


RangeData

Type: UIRoot.UIRangeData

Modifiers: config

Range data for the option, only used if its a slider type.

RequiredGameMode

Type: name

Modifiers: config

Game mode required for this option to appear.

SchemaCellFields

Type: array<name>

Modifiers: config

the names of the fields to use for populating schemas for list widgets

Enums

EMenuOptionType

MENUOT_ComboReadOnly
MENUOT_ComboNumeric
MENUOT_CheckBox
MENUOT_Slider
MENUOT_Spinner
MENUOT_EditBox
MENUOT_CollectionCheckBox
MENUOT_CollapsingList

Native functions

IsFiltered

function native virtual final bool IsFiltered ()

Returns:

Returns whether or not this provider should be filtered, by default it checks the platform flags.