Lumberyard
Legacy Reference

UI ScrollBar Component Nodes

Flow Graph is deprecated and will be removed in a future version of Lumberyard. Learn about Script Canvas, Lumberyard's new visual scripting environment.

This topic references tools and features that are legacy. If you want to use legacy tools in Lumberyard Editor, disable the CryEntity Removal gem using the Project Configurator or the command line. To learn about the latest features, see the Amazon Lumberyard User Guide.

The UI ScrollBar component flow graph nodes have been superseded by the UIe ScrollBar component flow graph nodes. For best results, use the UIe ScrollBar component flow graph nodes.

Use the following flow graph nodes to perform actions on the ScrollBar component.

UI:Scrollbar:GetHandleEntity Node

Gets the handle element of the scroll bar.

Node Inputs

Activate

Updates the output.

CanvasID

Unique identifier of the element's canvas.

ElementID

Unique identifier of the element.

Node Output

Handle

The handle element.

UI:Scrollbar:SetHandleEntity Node

Sets the handle element of the scroll bar.

Node Inputs

Activate

Sets the handle element.

CanvasID

Unique identifier of the element's canvas.

ElementID

Unique identifier of the element.

Handle

The handle element.

Node Output

Done

Sends a signal when the node's action is finished.

UI:Scrollbar:GetValue Node

Gets the value of the scroll bar.

Node Inputs

Activate

Updates the output.

CanvasID

Unique identifier of the element's canvas.

ElementID

Unique identifier of the element.

Node Output

Value

The scroll bar value of the element identified by ElementID.

UI:Scrollbar:SetValue Node

Sets the value of the scroll bar.

Node Inputs

Activate

Sets the value of the scroll bar.

CanvasID

Unique identifier of the element's canvas.

ElementID

Unique identifier of the element.

Value

The scroll bar value of the element identified by ElementID.

Node Output

Done

Sends a signal when the node's action is finished.

UI:Scrollbar:GetHandleSize Node

Gets the size of the handle.

Node Inputs

Activate

Updates the output.

CanvasID

Unique identifier of the element's canvas.

ElementID

Unique identifier of the element.

Node Output

HandleSize

The size of the handle of the element identified by ElementID.

UI:Scrollbar:SetHandleSize Node

Sets the size of the handle.

Node Inputs

Activate

Sets the size of the handle.

CanvasID

Unique identifier of the element's canvas.

ElementID

Unique identifier of the element.

HandleSize

The size of the handle of the element identified by ElementID.

Node Output

Done

Sends a signal when the node's action is finished.

UI:Scrollbar:GetMinHandlePixelSize Node

Gets the minimum size in pixels of the handle.

Node Inputs

Activate

Updates the output.

CanvasID

Unique identifier of the element's canvas.

ElementID

Unique identifier of the element.

Node Output

MinHandleSize

The minimum size in pixels of the handle of the element identified by ElementID.

UI:Scrollbar:SetMinHandlePixelSize Node

Sets the minimum size in pixels of the handle.

Node Inputs

Activate

Sets the minimum size in pixels of the handle.

CanvasID

Unique identifier of the element's canvas.

ElementID

Unique identifier of the element.

MinHandleSize

The minimum size in pixels of the handle of the element identified by ElementID.

Node Output

Done

Sends a signal when the node's action is finished.

UI:Scrollbar:GetValueChangedActionName Node

Gets the action triggered when the value is done changing.

Node Inputs

Activate

Updates the output.

CanvasID

Unique identifier of the element's canvas.

ElementID

Unique identifier of the element.

Node Output

ValueChangedAction

The action name.

UI:Scrollbar:SetValueChangedActionName Node

Sets the action triggered when the value is done changing.

Node Inputs

Activate

Updates the output.

CanvasID

Unique identifier of the element's canvas.

ElementID

Unique identifier of the element.

ValueChangedAction

The action name.

Node Output

Done

Sends a signal when the node's action is finished.

UI:Scrollbar:GetValueChangingActionName Node

Gets the action triggered while the value is changing.

Node Inputs

Activate

Updates the output.

CanvasID

Unique identifier of the element's canvas.

ElementID

Unique identifier of the element.

Node Output

ValueChangingAction

The action name.

UI:Scrollbar:SetValueChangingActionName Node

Sets the action triggered while the value is changing.

Node Inputs

Activate

Updates the output.

CanvasID

Unique identifier of the element's canvas.

ElementID

Unique identifier of the element.

ValueChangingAction

The action name.

Node Output

Done

Sends a signal when the node's action is finished.