UE3:UISlider (UT3)

Object >> UIRoot >> UIScreenObject >> UIObject >> UISlider

Package: 

Engine

Implemented interfaces: 

UIDataStorePublisher

Direct subclass:

UTUISlider

This class in other games:

UDK

This widget presents the user with an interface for choosing a value within a certain range.

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

Todo: hook up data store resolution

Properties

Property group 'Data'

CaptionRenderComponent

Type: UIComp_DrawStringSlider

Modifiers: editinline, const

Renders the caption for this slider

DataSource

Type: UIRoot.UIDataStoreBinding

Modifiers: editconst, private

The data source that this slider's value will be linked to.

Default value:

Member	Value
RequiredFieldType	DATATYPE_RangeProperty

Property group 'Image'

BackgroundImageComponent

Type: UIComp_DrawImage

Modifiers: editinline, const, noclear

Component for rendering the slider background image

Default value: UIComp_DrawImage'SliderBackgroundImageTemplate'

MarkerImageComponent

Type: UIComp_DrawImage

Modifiers: editinline, const, noclear

Component for rendering the slider marker image

Default value: UIComp_DrawImage'SliderMarkerImageTemplate'

SliderBarImageComponent

Type: UIComp_DrawImage

Modifiers: editinline, const, noclear

Component for rendering the slider bar image

Default value: UIComp_DrawImage'SliderBarImageTemplate'

Property group 'Slider'

BarSize

Type: UIRoot.UIScreenValue_Extent

Controls the size of the slider's bar. If slider is horizontal, controls the height of the bar; if slider is vertical, controls the width of the bar

Default value:

Member	Value
Value	32.0

bRenderCaption

Type: bool

Controls whether the caption is rendered above the slider marker

Default value: True

MarkerHeight

Type: UIRoot.UIScreenValue_Extent

Fixme: temp....the size of the region to use for rendering the marker

Default value:

Member	Value
Orientation	UIORIENT_Vertical
Value	16.0

MarkerWidth

Type: UIRoot.UIScreenValue_Extent

Fixme: temp....the size of the region to use for rendering the marker

Default value:

Member	Value
Value	16.0

SliderOrientation

Type: UIRoot.EUIOrientation

Controls whether this slider is vertical or horizontal not fully implemented

SliderValue

Type: UIRoot.UIRangeData

The value and range parameters for this slider.

Default value:

Member	Value
MaxValue	100.0
NudgeValue	1.0

Property group 'Sound'

DecrementCue

Type: name

this sound is played when the slider is decremented

Default value: 'SliderDecrement'

IncrementCue

Type: name

this sound is played when the slider is incremented

Default value: 'SliderIncrement'

Default values

Property	Value
bSupportsPrimaryStyle	False
DefaultStates[2]	Class'Engine.UIState_Focused'
DefaultStates[3]	Class'Engine.UIState_Active'
DefaultStates[4]	Class'Engine.UIState_Pressed'
Position	Member Value ScaleType[3] EVALPOS_PixelOwner Value[3] 32.0
PrimaryStyle	Member Value DefaultStyleTag 'DefaultSliderStyle' RequiredStyleClass Class'Engine.UIStyle_Image'

Subobjects

SliderBackgroundImageTemplate

Class: Engine.UIComp_DrawImage

Property	Value
ImageStyle	Member Value DefaultStyleTag 'DefaultSliderStyle'
StyleResolverTag	'Slider Background Style'

SliderBarImageTemplate

Class: Engine.UIComp_DrawImage

Property	Value
ImageStyle	Member Value DefaultStyleTag 'DefaultSliderBarStyle'
StyleResolverTag	'Slider Bar Style'

SliderMarkerImageTemplate

Class: Engine.UIComp_DrawImage

Property	Value
ImageStyle	Member Value DefaultStyleTag 'DefaultSliderMarkerStyle'
StyleResolverTag	'Slider Marker Style'

WidgetEventComponent

Class: Engine.UIComp_Event

Inherits from: UIObject.WidgetEventComponent

No new values.

Functions

Native functions

ClearBoundDataStores

native final function ClearBoundDataStores ()

Specified by: UIDataStoreSubscriber.ClearBoundDataStores

Notifies this subscriber to unbind itself from all bound data stores

GetBoundDataStores

native final virtual function GetBoundDataStores (out array<UIDataStore> out_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.

GetDataStoreBinding

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>

GetValue

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.

NotifyDataStoreValueUpdated

native final virtual 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

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

native final virtual function bool SaveSubscriberValue (out array<UIDataStore> out_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.

SetDataStoreBinding

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.

SetValue

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

Other instance functions

OnStateChanged

final function OnStateChanged (UIScreenObject Sender, int PlayerIndex, UIState NewlyActiveState, optional UIState PreviouslyActiveState)

Called when a new UIState becomes the widget's currently active state, after all activation logic has occurred.

Parameters:

• Sender - the widget that changed states.
• PlayerIndex - the index [into the GamePlayers array] for the player that activated this state.
• NewlyActiveState - the state that is now active
• PreviouslyActiveState - the state that used the be the widget's currently active state.

SetBackgroundImage

final function SetBackgroundImage (Surface NewImage)

Changes the background image for this slider, creating the wrapper UITexture if necessary.

Parameters:

• NewBarImage - the new surface to use for the slider's background image

SetBarImage

final function SetBarImage (Surface NewImage)

Changes the bar image for this slider, creating the wrapper UITexture if necessary.

Parameters:

• NewBarImage - the new surface to use for the slider's bar image

SetMarkerImage

final function SetMarkerImage (Surface NewImage)

Changes the marker image for this slider, creating the wrapper UITexture if necessary.

Parameters:

• NewImage - the new surface to use for slider's marker