Once I get that upgrade to 36-hour days, I will tackle that. – Mychaeel
UE3:UIOptionList (UDK)
 |
Object >> UIRoot >> UIScreenObject >> UIObject >> UIOptionListBase >> UIOptionList |
Contents
- Package:
- Engine
- Implemented interfaces:
- UIDataStorePublisher
- This class in other games:
- UT3
| This is an auto-generated page and may need human attention. Please remove the {{autogenerated}} tag if the page seems reasonably complete or replace it with the {{expand}} tag if the page is not yet complete. |
Option widget that works similar to a read only combobox.
Properties[edit]
CurrentIndex[edit]
Type: int
Modifiers: transient
Current index in the datastore
DataProvider[edit]
Type: UIListElementProvider
Modifiers: transient, const
the list element provider referenced by DataSource
Default values[edit]
| 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' |
Subobjects[edit]
BackgroundImageTemplate[edit]
Class: Engine.UIComp_DrawImage
Inherits from: UIOptionListBase.BackgroundImageTemplate
No new values.
LabelStringRenderer[edit]
Class: Engine.UIComp_DrawString
Inherits from: UIOptionListBase.LabelStringRenderer
No new values.
WidgetEventComponent[edit]
Class: Engine.UIComp_Event
Inherits from: UIOptionListBase.WidgetEventComponent
No new values.
Delegates[edit]
OnIsCurrValueValid[edit]
Delegate that can be used to determine if IsCurrValueValid() should succeed or not
Native functions[edit]
GetCurrentIndex[edit]
Returns:
- Returns the current index of the optionbutton.
GetListValue[edit]
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
IsCurrValueValid[edit]
Function to determine if the value at the currently selected index is valid
SetCurrentIndex[edit]
Sets a new index for the option button.
Parameters:
- NewIndex - New index for the option button.
SetNextValue[edit]
Increments the widget to the next value
SetPrevValue[edit]
Decrements the widget to the previous value
