I'm a doctor, not a mechanic
UE3:UIOptionList (UT3)
From Unreal Wiki, The Unreal Engine Documentation Site
 |
Object >> UIRoot >> UIScreenObject >> UIObject >> UIOptionListBase >> UIOptionList |
Contents |
- Package:
- Engine
- Implemented interfaces:
- UIDataStorePublisher
- This class in other games:
- UDK
| This is an auto-generated page and may need human attention. Please remove this tag if the page seems reasonably complete or replace it with the {{expand}} tag if the page is not yet complete. |
Copyright 2006-2007 Epic Games, Inc. All Rights Reserved.
Option widget that works similar to a read only combobox.
[edit] Properties
[edit] CurrentIndex
Type: int
Modifiers: transient
Current index in the datastore
[edit] DataProvider
Type: UIListElementProvider
Modifiers: transient, const
the list element provider referenced by DataSource
[edit] Default values
| Property | Value |
|---|---|
| Children[0] | UIOptionListButton'Engine.Default__UIOptionList:DecrementButtonTemplate' |
| Children[1] | UIOptionListButton'Engine.Default__UIOptionList:IncrementButtonTemplate' |
| DecrementButton | UIOptionListButton'Engine.Default__UIOptionList:DecrementButtonTemplate' |
| IncrementButton | UIOptionListButton'Engine.Default__UIOptionList:IncrementButtonTemplate' |
[edit] Subobjects
[edit] BackgroundImageTemplate
Class: Engine.UIComp_DrawImage
Inherits from: UIOptionListBase.BackgroundImageTemplate
No new values.
[edit] LabelStringRenderer
Class: Engine.UIComp_DrawString
Inherits from: UIOptionListBase.LabelStringRenderer
No new values.
[edit] WidgetEventComponent
Class: Engine.UIComp_Event
Inherits from: UIOptionListBase.WidgetEventComponent
No new values.
[edit] Functions
[edit] Native functions
[edit] GetCurrentIndex
Returns:
- Returns the current index of the optionbutton.
[edit] GetListValue
Parameters:
- ListIndex - List index to get the value of.
- OutValue - Storage string for the list value
Returns:
- Returns TRUE if we were able to get a value, FALSE otherwise
[edit] SetCurrentIndex
Sets a new index for the option button.
Parameters:
- NewIndex - New index for the option button.
[edit] SetNextValue
Increments the widget to the next value
[edit] SetPrevValue
Decrements the widget to the previous value
