The three virtues of a programmer: Laziness, Impatience, and Hubris. – Larry Wall
Difference between revisions of "UE3:UIOptionList (UDK)"
(Talk) |
(Talk) |
||
| Line 82: | Line 82: | ||
{{code|native final function [[bool]] '''GetListValue''' ([[int]] '''ListIndex''', out [[string]] '''OutValue''')}} | {{code|native final function [[bool]] '''GetListValue''' ([[int]] '''ListIndex''', out [[string]] '''OutValue''')}} | ||
| − | + | '''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==== | ====IsCurrValueValid==== | ||
Revision as of 05:24, 17 January 2010
 |
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
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.
Delegates
OnIsCurrValueValid
Delegate that can be used to determine if IsCurrValueValid() should succeed or not
Native functions
GetCurrentIndex
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
IsCurrValueValid
Function to determine if the value at the currently selected index is valid
SetCurrentIndex
Sets a new index for the option button.
Parameters:
- NewIndex - New index for the option button.
SetNextValue
Increments the widget to the next value
SetPrevValue
Decrements the widget to the previous value
