UE3:UIOptionList (UT3)
From Unreal Wiki, The Unreal Engine Documentation Site
![]() |
Object >> UIRoot >> UIScreenObject >> UIObject >> UIOptionListBase >> UIOptionList |
- Package:
- Engine
- Implemented interfaces:
- UIDataStorePublisher
- This class in other games:
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. |
Copyright 2006-2007 Epic Games, Inc. All Rights Reserved.
Option widget that works similar to a read only combobox.
Properties
CurrentIndex
Type: int
Modifiers: transient
Current index in the datastore
DataProvider
Type: UIListElementProvider
Modifiers: transient, const
the list element provider referenced by DataSource
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' |
Subobjects
BackgroundImageTemplate
Class: Engine.UIComp_DrawImage
Inherits from: UIOptionListBase.BackgroundImageTemplate
No new values.
LabelStringRenderer
Class: Engine.UIComp_DrawString
Inherits from: UIOptionListBase.LabelStringRenderer
No new values.
WidgetEventComponent
Class: Engine.UIComp_Event
Inherits from: UIOptionListBase.WidgetEventComponent
No new values.
Functions
Native functions
GetCurrentIndex
native function int GetCurrentIndex () const
Returns:
- Returns the current index of the optionbutton.
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
SetCurrentIndex
native function SetCurrentIndex (int NewIndex)
Sets a new index for the option button.
Parameters:
- NewIndex - New index for the option button.
SetNextValue
native function SetNextValue ()
Increments the widget to the next value
SetPrevValue
native function SetPrevValue ()
Decrements the widget to the previous value
Other instance functions
OnSetListIndex
protected final function OnSetListIndex (UIAction_SetListIndex Action)