Lumberyard
User Guide (Version 1.15)

UIScrollBarComponent

Controls scroll bar characteristics.

UiScrollBarBus

Services messages for the UiScrollBarComponent.

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()

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)