Menu
Lumberyard
Developer Guide (Version 1.11)

UISliderComponent

Controls the values of a slider.

UiSliderBus

Services messages for the UiSliderComponent.

GetFillEntity

Returns the fill element.

Syntax

Copy
AZ::EntityId GetFillEntity()

GetManipulatorEntity

Returns the entity ID of the manipulator element.

Syntax

Copy
AZ::EntityId GetManipulatorEntity()

GetMaxValue

Returns the maximum value of the slider.

Syntax

Copy
float GetMaxValue()

GetMinValue

Returns the minimum value of the slider.

Syntax

Copy
float GetMinValue()

GetStepValue

Returns the smallest increment allowed between values. Zero means no restriction.

Syntax

Copy
float GetStepValue()

GetTrackEntity

Returns the track element.

Syntax

Copy
AZ::EntityId GetTrackEntity()

GetValue

Returns the value of the slider.

Syntax

Copy
float GetValue()

GetValueChangedActionName

Returns the action triggered when the value has finished changing.

Syntax

Copy
const AZStd::string& GetValueChangedActionName()

GetValueChangingActionName

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

Syntax

Copy
const AZStd::string& GetValueChangingActionName()

SetFillEntity

Sets the fill element.

Syntax

Copy
void SetFillEntity(AZ::EntityId entityId)

SetManipulatorEntity

Sets the manipulator element.

Syntax

Copy
void SetManipulatorEntity(AZ::EntityId entityId)

SetMaxValue

Sets the maximum value of the slider.

Syntax

Copy
void SetMaxValue(float value)

SetMinValue

Sets the minimum value of the slider.

Syntax

Copy
void SetMinValue(float value)

SetStepValue

Sets the smallest increment allowed between values. Use zero for no restriction.

Syntax

Copy
void SetStepValue(float step)

SetTrackEntity

Sets the track element.

Syntax

Copy
void SetTrackEntity(AZ::EntityId entityId)

SetValue

Sets the value of the slider.

Syntax

Copy
void SetValue(float value)

SetValueChangedActionName

Sets the action triggered when the value is done changing.

Syntax

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

SetValueChangingActionName

Sets the action triggered while the value is changing.

Syntax

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

UiSliderNotificationBus

Services notifications for the UiSliderComponent.

OnSliderValueChanged

The slider value has finished changing.

Syntax

Copy
void OnSliderValueChanged(float value)

OnSliderValueChanging

The slider value is changing.

Syntax

Copy
void OnSliderValueChanging(float value)