UIScrollBarComponent - Lumberyard User Guide

UIScrollBarComponent

Open 3D Engine (O3DE), the successor to Lumberyard, is now available in Developer Preview. Download O3DE or visit the AWS Game Tech blog to learn more.

Controls scroll bar characteristics.

UiScrollBarBus

Services messages for the UiScrollBarComponent.

GetAutoFadeDelay

Returns the fade delay in seconds.

Minimum Lumberyard Version: 1.24

Syntax

float GetAutoFadeDelay()

GetAutoFadeSpeed

Returns the fade speed in seconds.

Minimum Lumberyard Version: 1.24

Syntax

float GetAutoFadeSpeed()

GetHandleEntity

Returns the handle entity.

Syntax

AZ::EntityId GetHandleEntity()

GetHandleSize

Returns the size of the handle relative to the scroll bar (0 - 1).

Syntax

float GetHandleSize()

GetMinHandlePixelSize

Returns the minimum size of the handle in pixels.

Syntax

float GetMinHandlePixelSize()

IsAutoFadeEnabled

Returns whether auto fade is enabled.

Minimum Lumberyard Version: 1.24

Syntax

bool IsAutoFadeEnabled()

SetAutoFadeDelay

Sets the fade delay in seconds.

Minimum Lumberyard Version: 1.24

Syntax

void SetAutoFadeDelay(float delay)

SetAutoFadeEnabled

Sets whether auto fade is enabled.

Minimum Lumberyard Version: 1.24

Syntax

void SetAutoFadeEnabled(bool isEnabled)

SetAutoFadeSpeed

Sets the fade speed in seconds.

Minimum Lumberyard Version: 1.24

Syntax

void SetAutoFadeSpeed(float speed)

SetHandleEntity

Sets the handle entity.

Syntax

void SetHandleEntity(AZ::EntityId entityId)

SetHandleSize

Sets the size of the handle relative to the scroll bar (0 - 1).

Syntax

void SetHandleSize(float size)

SetMinHandlePixelSize

Sets the minimum size of the handle in pixels.

Syntax

void SetMinHandlePixelSize(float size)

UiScrollerBus

Services scrolling for the UiScrollBarComponent.

GetOrientation

Returns the orientation of the scroller.

Syntax

eUiScrollerOrientation GetOrientation()

Following are possible values for eUiScrollerOrientation.

enum eUiScrollerOrientation { eUiScrollerOrientation_Horizontal, eUiScrollerOrientation_Vertical };

GetValue

Returns the current value for the scroller (0 - 1).

Syntax

float GetValue()

GetValueChangedActionName

Returns the name of the action triggered when the value has changed.

Syntax

const AZStd::string& GetValueChangedActionName()

GetValueChangingActionName

Returns the name of the action triggered while the value is changing.

Syntax

AZStd::string& GetValueChangingActionName()

SetOrientation

Sets the orientation of the scroller.

Syntax

SetOrientation(eUiScrollerOrientation orientation)

For possible values for eUiScrollerOrientation, see GetOrientation.

SetValue

Sets the value of the scroller (0 - 1).

Syntax

void SetValue(float value)

SetValueChangedActionName

Sets the action triggered when the value has changed.

Syntax

void SetValueChangedActionName(const AZStd::string& actionName)

SetValueChangingActionName

Sets the name of the action triggered while the value is changing.

Syntax

void SetValueChangingActionName(const AZStd::string& actionName)