Cogito, ergo sum

UE3:UIDataProvider_MenuItem (UDK)

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

Property group 'UIDataProvider_MenuItem'[edit]

bSearchAllInis[edit]

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

bEditableCombo[edit]

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

Type: bool

Modifiers: config

Whether the option is a keyboard or mouse option.

bNumericCombo[edit]

Type: bool

Modifiers: config

Whether or not the combobox is numeric.

bOfflineOnly[edit]

Type: bool

Modifiers: config

Whether the option is a offline only option or not.

bOnlineOnly[edit]

Type: bool

Modifiers: config

Whether the option is a online only option or not.

bRemoveOn360[edit]

Type: bool

Modifiers: config

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

bRemoveOnPC[edit]

Type: bool

Modifiers: config


bRemoveOnPS3[edit]

Type: bool

Modifiers: config


CustomFriendlyName[edit]

Type: string

Script settable friendly name.

DataStoreMarkup[edit]

Type: string

Modifiers: config

Markup for the option

Description[edit]

Type: string

Modifiers: config, localized

Localized description of the option

DescriptionMarkup[edit]

Type: string

Modifiers: config

Markup for the description for the option

EditboxAllowedChars[edit]

Type: UIRoot.EEditBoxCharacterSet

Modifiers: config

the allowed character set for editboxes

EditBoxMaxLength[edit]

Type: int

Modifiers: config

Maximum length of the editbox property.

FriendlyName[edit]

Type: string

Modifiers: config, localized

Friendly displayable name to the player.

IniName[edit]

Type: string

Modifiers: const

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

OptionSet[edit]

Type: array<name>

Modifiers: config

Name of the option set that this option belongs to.

OptionType[edit]

Type: EMenuOptionType

Modifiers: config


RangeData[edit]

Type: UIRoot.UIRangeData

Modifiers: config

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

RequiredGameMode[edit]

Type: name

Modifiers: config

Game mode required for this option to appear.

SchemaCellFields[edit]

Type: array<name>

Modifiers: config

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

Enums[edit]

EMenuOptionType[edit]

MENUOT_ComboReadOnly 
MENUOT_ComboNumeric 
MENUOT_CheckBox 
MENUOT_Slider 
MENUOT_Spinner 
MENUOT_EditBox 
MENUOT_CollectionCheckBox 
MENUOT_CollapsingList 

Native functions[edit]

IsFiltered[edit]

function native virtual final bool IsFiltered ()

Returns:

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