Once I get that upgrade to 36-hour days, I will tackle that. – Mychaeel

UE3:UINumericOptionList (UDK)

From Unreal Wiki, The Unreal Engine Documentation Site
Revision as of 05:50, 17 January 2010 by Wormbo (Talk | contribs) (1 revision: class descriptions for UDK January update (part 6))

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search
UDK Object >> UIRoot >> UIScreenObject >> UIObject >> UIOptionListBase >> UINumericOptionList
Package: 
Engine
Implemented interfaces
UIDataStorePublisher
This class in other games:
UT3

Copyright 2006-2007 Epic Games, Inc. All Rights Reserved.

Widget which looks like a UIOptionList but contains a numeric range for its data instead of a list of strings

Properties[edit]

Property group 'Data'[edit]

RangeValue[edit]

Type: UIRoot.UIRangeData

The value and range parameters for this numeric optionlist.

Default value:

Member Value
NudgeValue 1.0

Default values[edit]

Property Value
Children[0] UIOptionListButton'Engine.Default__UINumericOptionList:DecrementButtonTemplate'
Children[1] UIOptionListButton'Engine.Default__UINumericOptionList:IncrementButtonTemplate'
DataSource
Member Value
RequiredFieldType DATATYPE_RangeProperty
DecrementButton UIOptionListButton'Engine.Default__UINumericOptionList:DecrementButtonTemplate'
IncrementButton UIOptionListButton'Engine.Default__UINumericOptionList: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.

Native functions[edit]

GetValue[edit]

native final function float GetValue (optional bool bPercentageValue) const

Gets the current value of this slider

Parameters:

  • bPercentageValue - TRUE to format the result as a percentage of the total range of this slider.

SetValue[edit]

native final function bool SetValue (coerce float NewValue, optional bool bPercentageValue)

Change the value of this slider at runtime.

Parameters:

  • NewValue - the new value for the slider.
  • bPercentageValue - TRUE indicates that the new value is formatted as a percentage of the total range of this slider.

Returns:

TRUE if the slider's value was changed