Menu
Lumberyard
Legacy Reference

UI ScrollBox 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 Scrollbox component flow graph nodes have been superseded by the UIe Scrollbox component flow graph nodes. For best results, use the UIe Scrollbox component flow graph nodes.

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

UI:ScrollBox:FindClosestContentChildElement Node

Finds the child of the content element that is closest to the content anchors.

Node Inputs

Activate

Updates the outputs.

CanvasID

Unique identifier of the element's canvas.

ElementID

Unique identifier of the element.

Node Output

ClosestElement

The element currently closest to the focused element.

UI:ScrollBox:GetContentEntity Node

Gets the content element for the ScrollBox.

Node Inputs

Activate

Updates the outputs.

CanvasID

Unique identifier of the element's canvas.

ElementID

Unique identifier of the element.

Node Output

Content

The element that the ScrollBox scrolls.

UI:ScrollBox:SetContentEntity Node

Sets the content element for the ScrollBox.

Node Inputs

Activate

Sets the content element for the ScrollBox.

CanvasID

Unique identifier of the element's canvas.

ElementID

Unique identifier of the element.

Content

The element that the ScrollBox scrolls.

Node Output

Done

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

UI:ScrollBox:GetIsHorizontalScrollingEnabled Node

Gets whether the ScrollBox allows horizontal scrolling.

Node Inputs

Activate

Updates the outputs.

CanvasID

Unique identifier of the element's canvas.

ElementID

Unique identifier of the element.

Node Output

Enabled

Indicates whether horizontal scrolling is enabled.

UI:ScrollBox:SetIsHorizontalScrollingEnabled Node

Sets whether the ScrollBox allows horizontal scrolling.

Node Inputs

Activate

Sets whether the ScrollBox allows horizontal scrolling.

CanvasID

Unique identifier of the element's canvas.

ElementID

Unique identifier of the element.

Enabled

Sets whether horizontal scrolling is enabled.

Node Output

Done

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

UI:ScrollBox:GetIsScrollingConstrained Node

Gets whether the ScrollBox restricts scrolling to the content area.

Node Inputs

Activate

Updates the outputs.

CanvasID

Unique identifier of the element's canvas.

ElementID

Unique identifier of the element.

Node Output

IsConstrained

Indicates whether scrolling is constrained.

UI:ScrollBox:SetIsScrollingConstrained Node

Sets whether the ScrollBox restricts scrolling to the content area.

Node Inputs

Activate

Sets whether the ScrollBox restricts scrolling to the content area.

CanvasID

Unique identifier of the element's canvas.

ElementID

Unique identifier of the element.

IsConstrained

Sets whether scrolling is constrained.

Node Output

Done

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

UI:ScrollBox:GetIsVerticalScrollingEnabled Node

Gets whether the ScrollBox allows vertical scrolling.

Node Inputs

Activate

Updates the output.

CanvasID

Unique identifier of the element's canvas.

ElementID

Unique identifier of the element.

Node Output

Enabled

Indicates whether vertical scrolling is enabled.

UI:ScrollBox:SetIsVerticalScrollingEnabled Node

Sets whether the ScrollBox allows vertical scrolling.

Node Inputs

Activate

Sets whether the ScrollBox allows vertical scrolling.

CanvasID

Unique identifier of the element's canvas.

ElementID

Unique identifier of the element.

Enabled

Sets whether vertical scrolling is enabled.

Node Output

Done

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

UI:ScrollBox:GetScrollOffset Node

Gets the scroll offset of the ScrollBox.

Node Inputs

Activate

Updates the outputs.

CanvasID

Unique identifier of the element's canvas.

ElementID

Unique identifier of the element.

Node Output

HorizOffset

The horizontal scroll offset of the element identified by ElementID.

VertOffset

The vertical scroll offset of the element identified by ElementID.

UI:ScrollBox:SetScrollOffset Node

Sets the scroll offset of the ScrollBox.

Node Inputs

Activate

Sets the scroll offset of the ScrollBox.

CanvasID

Unique identifier of the element's canvas.

ElementID

Unique identifier of the element.

HorizOffset

The horizontal scroll offset of ElementID.

VertOffset

The vertical scroll offset of ElementID.

Node Output

Done

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

UI:ScrollBox:GetScrollOffsetChangedActionName Node

Gets the action triggered when the ScrollBox drag is completed.

Node Inputs

Activate

Updates the output.

CanvasID

Unique identifier of the element's canvas.

ElementID

Unique identifier of the element.

Node Output

ChangedAction

The action name.

UI:ScrollBox:SetScrollOffsetChangedActionName Node

Sets the action triggered when the ScrollBox drag is completed.

Node Inputs

Activate

Sets the action triggered when the ScrollBox drag is completed.

CanvasID

Unique identifier of the element's canvas.

ElementID

Unique identifier of the element.

ChangedAction

The action name.

Node Output

Done

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

UI:ScrollBox:GetScrollOffsetChangingActionName Node

Gets the action triggered while the ScrollBox is being dragged.

Node Inputs

Activate

Updates the output.

CanvasID

Unique identifier of the element's canvas.

ElementID

Unique identifier of the element.

Node Output

ChangingAction

The action name.

UI:ScrollBox:SetScrollOffsetChangingActionName Node

Sets the action triggered while the ScrollBox is being dragged.

Node Inputs

Activate

Sets the action triggered while the ScrollBox is being dragged.

CanvasID

Unique identifier of the element's canvas.

ElementID

Unique identifier of the element.

ChangingAction

The action name.

Node Output

Done

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

UI:ScrollBox:GetSnapGrid Node

Gets the snapping grid of the ScrollBox.

Node Inputs

Activate

Updates the outputs.

CanvasID

Unique identifier of the element's canvas.

ElementID

Unique identifier of the element.

Node Outputs

HorizSpacing

The horizontal grid spacing of the element identified by ElementID.

VertSpacing

The vertical grid spacing of the element identified by ElementID.

UI:ScrollBox:SetSnapGrid Node

Sets the snapping grid of the ScrollBox.

Node Inputs

Activate

Sets the snapping grid of the ScrollBox.

CanvasID

Unique identifier of the element's canvas.

ElementID

Unique identifier of the element.

HorizSpacing

The horizontal grid spacing of the element identified by ElementID.

VertSpacing

The vertical grid spacing of the element identified by ElementID.

Node Output

Done

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

UI:ScrollBox:GetSnapMode Node

Gets the snap mode for the ScrollBox.

Node Inputs

Activate

Updates the output.

CanvasID

Unique identifier of the element's canvas.

ElementID

Unique identifier of the element.

Node Output

SnapMode

An integer representing the snap mode state.

Valid values: 0 = None | 1 = Children | 2 = Grid

UI:ScrollBox:SetSnapMode Node

Sets the snap mode for the ScrollBox.

Node Inputs

Activate

Sets the snap mode for the ScrollBox.

CanvasID

Unique identifier of the element's canvas.

ElementID

Unique identifier of the element.

SnapMode

An integer representing the snap mode state.

Valid values: 0 = None | 1 = Children | 2 = Grid

Node Output

Done

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

UI:ScrollBox:GetHorizontalScrollBarVisibility Node

Gets horizontal scroll bar visibility behavior.

Node Inputs

Activate

Updates the outputs.

CanvasID

Unique identifier of the element's canvas.

ElementID

Unique identifier of the element.

Node Output

ScrollBarVisibility

An integer that represents the scroll bar visibility behavior.

Valid values: 0 = AlwaysVisible | 1 = AutoHide | 2 = AutoHideAndResizeViewArea

UI:ScrollBox:SetHorizontalScrollBarVisibility Node

Sets horizontal scroll bar visibility behavior.

Node Inputs

Activate

Sets horizontal scroll bar visibility behavior.

CanvasID

Unique identifier of the element's canvas.

ElementID

Unique identifier of the element.

ScollBarVisibility

An integer representing the scroll bar visibility behavior.

0 = AlwaysVisible | 1 = AutoHide | 2 = AutoHideAndResizeViewArea.

Node Output

Done

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

UI:ScrollBox:GetVerticalScrollBarVisibility Node

Gets vertical scroll bar visibility behavior.

Node Inputs

Activate

Updates the outputs.

CanvasID

Unique identifier of the element's canvas.

ElementID

Unique identifier of the element.

Node Output

ScrollBarVisibility

An integer that represents the scroll bar visibility behavior.

Valid values: 0 = AlwaysVisible | 1 = AutoHide | 2 = AutoHideAndResizeViewArea

UI:ScrollBox:SetVerticalScrollBarVisibility Node

Sets vertical scroll bar visibility behavior.

Node Inputs

Activate

Sets vertical scroll bar visibility behavior.

CanvasID

Unique identifier of the element's canvas.

ElementID

Unique identifier of the element.

ScollBarVisibility

An integer representing the scroll bar visibility behavior.

0 = AlwaysVisible | 1 = AutoHide | 2 = AutoHideAndResizeViewArea.

Node Output

Done

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

UI:ScrollBox:GetHorizontalScrollBarEntity Node

Gets the horizontal scroll bar element for the ScrollBox.

Node Inputs

Activate

Updates the outputs.

CanvasID

Unique identifier of the element's canvas.

ElementID

Unique identifier of the element.

Node Output

HorizontalScrollBar

The element that scrolls the ScrollBox horizontally.

UI:ScrollBox:SetHorizontalScrollBarEntity Node

Sets the horizontal scroll bar element for the ScrollBox.

Node Inputs

Activate

Sets the horizontal scroll bar element for the ScrollBox.

CanvasID

Unique identifier of the element's canvas.

ElementID

Unique identifier of the element.

HorizontalScrollBar

The element that scrolls the ScrollBox horizontally.

Node Output

Done

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

UI:ScrollBox:GetVerticalScrollBarEntity Node

Gets the vertical scroll bar element for the ScrollBox.

Node Inputs

Activate

Updates the outputs.

CanvasID

Unique identifier of the element's canvas.

ElementID

Unique identifier of the element.

Node Output

VerticalScrollBar

The element that scrolls the ScrollBox vertically.

UI:ScrollBox:SetVerticalScrollBarEntity Node

Sets the vertical scroll bar element for the ScrollBox.

Node Inputs

Activate

Sets the vertical scroll bar element for the ScrollBox.

CanvasID

Unique identifier of the element's canvas.

ElementID

Unique identifier of the element.

VerticalScrollBar

The element that scrolls the ScrollBox vertically.

Node Output

Done

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