Cogito, ergo sum

UE3:UTUIDataProvider_MenuOption (UT3)

From Unreal Wiki, The Unreal Engine Documentation Site
Revision as of 06:02, 16 August 2009 by Wormbo (Talk | contribs) (added missing members)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search
Package: 
UTGame
Implemented interfaces
UIListElementCellProvider
This class in other games:
UDK

Provides an option for a UI menu item.

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

Properties

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.

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

EditboxAllowedChars

Type: UIEditBox.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.

OptionIndex

Type: int

Modifiers: config

NOTE: To set an option as the first menu option, set OptionIndex to 1; OptionIndex is ignored when set to 0

OptionSet

Type: array<name>

Modifiers: config

Name of the option set that this option belongs to.

OptionType

Type: EUTOptionType

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.

Enums

EUTOptionType

UTOT_ComboReadOnly 
UTOT_ComboNumeric 
UTOT_CheckBox 
UTOT_Slider 
UTOT_Spinner 
UTOT_EditBox 
UTOT_CollectionCheckBox