Mostly Harmless

UE3:UTUIOptionButton (UT3)

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
UT3 Object >> UIRoot >> UIScreenObject >> UIObject >> UTUI_Widget >> UTUIOptionButton
Package: 
UTGame
Implemented interfaces
UIDataStorePublisher
This class in other games:
UDK

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

Option widget that works similar to a read only combobox.

Constants[edit]

UIKEY_MoveCursorLeft[edit]

Value: 'UIKEY_MoveCursorLeft'

UI Key Action Events

UIKEY_MoveCursorRight[edit]

Value: 'UIKEY_MoveCursorRight'


Properties[edit]

Property group 'Data'[edit]

DataSource[edit]

Type: UIRoot.UIDataStoreBinding

The data store that this list is bound to

Default value:

Member Value
RequiredFieldType DATATYPE_Collection

StringRenderComponent[edit]

Type: UIComp_DrawString

Modifiers: editinline, const, noclear

Renders the text displayed by this label

Default value: UIComp_DrawString'LabelStringRenderer'

Property group 'Image'[edit]

BackgroundImageComponent[edit]

Type: UIComp_DrawImage

Modifiers: editinline, const, noclear

Component for rendering the button background image

Default value: UIComp_DrawImage'BackgroundImageTemplate'

Property group 'Presentation'[edit]

ButtonSpacing[edit]

Type: UIRoot.UIScreenValue

Spacing between buttons and text.

Default value:

Member Value
ScaleType EVALPOS_PixelOwner

Property group 'Sound'[edit]

DecrementCue[edit]

Type: name

this sound is played when the index is decremented

Default value: 'SliderDecrement'

IncrementCue[edit]

Type: name

this sound is played when the index is incremented

Default value: 'SliderIncrement'

Property group 'UTUIOptionButton'[edit]

bCustomPlacement[edit]

Type: bool

If true, this widget won't attempt to align it's children

bWrapOptions[edit]

Type: bool

Whether we should wrap the options or not, meaning if the user hits the beginning or the end of the list, they will wrap to the other end of the list.

Default value: True

Internal variables[edit]

ArrowLeftButton[edit]

Type: UIButton

Modifiers: instanced

Left and right arrow buttons for this widget.

Default value: UIButton'UTGame.Default__UTUIOptionButton:LeftArrowButtonTemplate'

ArrowRightButton[edit]

Type: UIButton

Modifiers: instanced


Default value: UIButton'UTGame.Default__UTUIOptionButton:RightArrowButtonTemplate'

CurrentIndex[edit]

Type: int

Modifiers: transient

Profile settings current index.

DataProvider[edit]

Type: UIListElementProvider

Modifiers: const, transient

the list element provider referenced by DataSource

DecrementStyle[edit]

Type: UIRoot.UIStyleReference

Modifiers: private


Default value:

Member Value
DefaultStyleTag 'DefaultOptionButtonLeftArrowStyle'
RequiredStyleClass Class'Engine.UIStyle_Image'

IncrementStyle[edit]

Type: UIRoot.UIStyleReference

Modifiers: private

The styles used for the increment, decrement and marker buttons

Default value:

Member Value
DefaultStyleTag 'DefaultOptionButtonRightArrowStyle'
RequiredStyleClass Class'Engine.UIStyle_Image'

Default values[edit]

Property Value
DefaultStates[2] Class'Engine.UIState_Focused'
DefaultStates[3] Class'Engine.UIState_Active'
DefaultStates[4] Class'Engine.UIState_Pressed'
Position
Member Value
ScaleType[2] EVALPOS_PixelOwner
ScaleType[3] EVALPOS_PixelOwner
Value[2] 256.0
Value[3] 32.0

Subobjects[edit]

BackgroundImageTemplate[edit]

Class: Engine.UIComp_DrawImage

Property Value
ImageStyle
Member Value
DefaultStyleTag 'OptionButtonBackground'
StyleResolverTag 'Background Image Style'

LabelStringRenderer[edit]

Class: Engine.UIComp_DrawString

Property Value
StringStyle
Member Value
DefaultStyleTag 'DefaultOptionButtonStyle'
StyleResolverTag 'Caption Style'

LeftArrowButtonTemplate[edit]

Class: Engine.UIButton

Property Value
Position
Member Value
Value[0] 0.603122
Value[1] 0.125
Value[2] 0.209372
Value[3] 0.750006
PrivateFlags 2087
TabIndex 0
WidgetTag 'butArrowLeft'

RightArrowButtonTemplate[edit]

Class: Engine.UIButton

Property Value
Position
Member Value
Value[0] 0.790628
Value[1] 0.125
Value[2] 0.209372
Value[3] 0.75
PrivateFlags 2087
TabIndex 1
WidgetTag 'butArrowRight'

WidgetEventComponent[edit]

Class: Engine.UIComp_Event

Inherits from: UTUI_Widget.WidgetEventComponent

No new values.

Enums[edit]

EOptionButtonArrow[edit]

Arrow enums.

OPTBUT_ArrowLeft 
OPTBUT_ArrowRight 

Functions[edit]

Native functions[edit]

ClearBoundDataStores[edit]

native final virtual function ClearBoundDataStores ()

Specified by: UIDataStoreSubscriber.ClearBoundDataStores

Notifies this subscriber to unbind itself from all bound data stores

GetBoundDataStores[edit]

native final virtual function GetBoundDataStores (out array<UIDataStoreout_BoundDataStores)

Specified by: UIDataStoreSubscriber.GetBoundDataStores

Retrieves the list of data stores bound by this subscriber.

Parameters:

  • out_BoundDataStores - receives the array of data stores that subscriber is bound to.

GetCurrentIndex[edit]

native function int GetCurrentIndex ()

Returns:

Returns the current index of the optionbutton.

GetDataStoreBinding[edit]

native final virtual function string GetDataStoreBinding (optional int BindingIndex) const

Specified by: UIDataStoreSubscriber.GetDataStoreBinding

Retrieves the markup string corresponding to the data store that this object is bound to.

Parameters:

  • BindingIndex - optional parameter for indicating which data store binding is being requested for those objects which have multiple data store bindings. How this parameter is used is up to the class which implements this interface, but typically the "primary" data store will be index 0.

Returns:

a datastore markup string which resolves to the datastore field that this object is bound to, in the format: <DataStoreTag:DataFieldTag>

HasNextValue[edit]

native function bool HasNextValue ()

Returns:

TRUE if the CurrentIndex is at the start of the ValueMappings array, FALSE otherwise.

HasPrevValue[edit]

native function bool HasPrevValue ()

Returns:

TRUE if the CurrentIndex is at the start of the ValueMappings array, FALSE otherwise.

NotifyDataStoreValueUpdated[edit]

native function NotifyDataStoreValueUpdated (UIDataStore SourceDataStore, bool bValuesInvalidated, name PropertyTag, UIDataProvider SourceProvider, int ArrayIndex)

Specified by: UIDataStoreSubscriber.NotifyDataStoreValueUpdated

Handler for the UIDataStore.OnDataStoreValueUpdated delegate. Used by data stores to indicate that some data provided by the data has changed. Subscribers should use this function to refresh any data store values being displayed with the updated value. notify subscribers when they should refresh their values from this data store.

Parameters:

  • SourceDataStore - the data store that generated the refresh notification; useful for subscribers with multiple data store bindings, to tell which data store sent the notification.
  • PropertyTag - the tag associated with the data field that was updated; Subscribers can use this tag to determine whether there is any need to refresh their data values.
  • SourceProvider - for data stores which contain nested providers, the provider that contains the data which changed.
  • ArrayIndex - for collection fields, indicates which element was changed. value of INDEX_NONE indicates not an array or that the entire array was updated.

RefreshSubscriberValue[edit]

native final virtual function bool RefreshSubscriberValue (optional int BindingIndex)

Specified by: UIDataStoreSubscriber.RefreshSubscriberValue

Resolves this subscriber's data store binding and updates the subscriber with the current value from the data store.

Returns:

TRUE if this subscriber successfully resolved and applied the updated value.

SaveSubscriberValue[edit]

native virtual function bool SaveSubscriberValue (out array<UIDataStoreout_BoundDataStores, optional int BindingIndex)

Specified by: UIDataStorePublisher.SaveSubscriberValue

Resolves this subscriber's data store binding and publishes this subscriber's value to the appropriate data store.

Parameters:

  • out_BoundDataStores - contains the array of data stores that widgets have saved values to. Each widget that implements this method should add its resolved data store to this array after data values have been published. Once SaveSubscriberValue has been called on all widgets in a scene, OnCommit will be called on all data stores in this array.
  • BindingIndex - optional parameter for indicating which data store binding is being requested for those objects which have multiple data store bindings. How this parameter is used is up to the class which implements this interface, but typically the "primary" data store will be index 0.

Returns:

TRUE if the value was successfully published to the data store.

SetCurrentIndex[edit]

native function SetCurrentIndex (int NewIndex)

Sets a new index for the option button.

Parameters:

  • NewIndex - New index for the option button.

SetDataStoreBinding[edit]

native final virtual function SetDataStoreBinding (string MarkupText, optional int BindingIndex)

Specified by: UIDataStoreSubscriber.SetDataStoreBinding

Sets the data store binding for this object to the text specified.

Parameters:

  • MarkupText - a markup string which resolves to data exposed by a data store. The expected format is: <DataStoreTag:DataFieldTag>
  • BindingIndex - optional parameter for indicating which data store binding is being requested for those objects which have multiple data store bindings. How this parameter is used is up to the class which implements this interface, but typically the "primary" data store will be index 0.

SetNextValue[edit]

native function SetNextValue ()

Moves the current index forward by 1 in the valuemappings array if it isn't already at the end of the array.

SetPrevValue[edit]

native function SetPrevValue ()

Moves the current index back by 1 in the valuemappings array if it isn't already at the front of the array.

Events[edit]

Initialized[edit]

event Initialized ()

Overrides: UIScreenObject.Initialized

Called once this screen object has been completely initialized, before it has called Initialize on its children.

OnMoveSelectionLeft[edit]

event OnMoveSelectionLeft (int PlayerIndex)

Moves the current selection to the left.

OnMoveSelectionRight[edit]

event OnMoveSelectionRight (int PlayerIndex)

Moves the current selection to the right.

PostInitialize[edit]

event PostInitialize ()

Overrides: UIScreenObject.PostInitialize

Called after the widget is done initializing.

Other instance functions[edit]

OnArrowLeft_Clicked[edit]

function bool OnArrowLeft_Clicked (UIScreenObject InButton, int PlayerIndex)

Arrow left clicked callback.

OnArrowRight_Clicked[edit]

function bool OnArrowRight_Clicked (UIScreenObject InButton, int PlayerIndex)

Arrow right clicked callback.

VerifyArrowButtons[edit]

function VerifyArrowButtons ()