Menu
Lumberyard
Developer Guide (Version 1.11)

UIScrollBarComponent

Controls scroll bar characteristics.

UiScrollBarBus

Services messages for the UiScrollBarComponent.

GetHandleEntity

Returns the handle entity.

Syntax

Copy
AZ::EntityId GetHandleEntity()

GetHandleSize

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

Syntax

Copy
float GetHandleSize()

GetMinHandlePixelSize

Returns the minimum size of the handle in pixels.

Syntax

Copy
float GetMinHandlePixelSize()

SetHandleEntity

Sets the handle entity.

Syntax

Copy
void SetHandleEntity(AZ::EntityId entityId)

SetHandleSize

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

Syntax

Copy
void SetHandleSize(float size)

SetMinHandlePixelSize

Sets the minimum size of the handle in pixels.

Syntax

Copy
void SetMinHandlePixelSize(float size)

UiScrollerBus

Services scrolling for the UiScrollBarComponent.

GetOrientation

Returns the orientation of the scroller.

Syntax

Copy
eUiScrollerOrientation GetOrientation()

Following are possible values for eUiScrollerOrientation.

Copy
enum eUiScrollerOrientation { eUiScrollerOrientation_Horizontal, eUiScrollerOrientation_Vertical };

GetValue

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

Syntax

Copy
float GetValue()

GetValueChangedActionName

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

Syntax

Copy
const AZStd::string& GetValueChangedActionName()

GetValueChangingActionName

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

Syntax

Copy
AZStd::string& GetValueChangingActionName()

SetOrientation

Sets the orientation of the scroller.

Syntax

Copy
SetOrientation(eUiScrollerOrientation orientation)

For possible values for eUiScrollerOrientation, see GetOrientation.

SetValue

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

Syntax

Copy
void SetValue(float value)

SetValueChangedActionName

Sets the action triggered when the value has changed.

Syntax

Copy
void SetValueChangedActionName(const AZStd::string& actionName)

SetValueChangingActionName

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

Syntax

Copy
void SetValueChangingActionName(const AZStd::string& actionName)