Lumberyard
Legacy Reference

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

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

UI:LayoutGrid:GetCellSize Node

Gets the size (in pixels) of a child element in the layout.

Node Inputs

Activate

Updates the output.

CanvasID

Unique identifier of the element's canvas.

ElementID

Unique identifier of the element.

Node Outputs

CellWidth

The width (in pixels) of a child element of element (ElementID).

CellHeight

The height (in pixels) of a child element of element (ElementID).

UI:LayoutGrid:SetCellSize Node

Sets the size (in pixels) of a child element in the layout.

Node Inputs

Activate

Updates the output.

CanvasID

Unique identifier of the element's canvas.

ElementID

Unique identifier of the element.

CellWidth

The width (in pixels) of a child element of element (ElementID).

CellHeight

The height (in pixels) of a child element of element (ElementID).

Node Output

Done

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

UI:LayoutGrid:GetHorizontalOrder Node

Gets the horizontal order for the layout.

Node Inputs

Activate

Updates the outputs.

CanvasID

Unique identifier of the element's canvas.

ElementID

Unique identifier of the element.

Node Output

Order

An integer representing the horizontal order.

Valid values: 0 = Left to right | 1 = Right to left

UI:LayoutGrid:SetHorizontalOrder Node

Sets the horizontal order for the layout.

Node Inputs

Activate

Updates the outputs.

CanvasID

Unique identifier of the element's canvas.

ElementID

Unique identifier of the element.

Order

An integer representing the horizontal order.

Valid values: 0 = Left to right | 1 = Right to left

Node Output

Done

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

UI:LayoutGrid:GetPadding Node

Gets the padding (in pixels) inside the edges of the LayoutGrid component for an element.

Node Inputs

Activate

Updates the output.

CanvasID

Unique identifier of the element's canvas.

ElementID

Unique identifier of the element.

Node Output

Left

An integer representing the padding inside the left edge of the element.

Right

An integer representing the padding inside the right edge of the element.

Top

An integer representing the padding inside the top edge of the element.

Bottom

An integer representing the padding inside the bottom edge of the element.

UI:LayoutGrid:SetPadding Node

Sets the padding (in pixels) inside the edges of the LayoutGrid component for an element.

Node Inputs

Activate

Updates the output.

CanvasID

Unique identifier of the element's canvas.

ElementID

Unique identifier of the element.

Left

An integer representing the padding inside the left edge of the element.

Right

An integer representing the padding inside the right edge of the element.

Top

An integer representing the padding inside the top edge of the element.

Bottom

An integer representing the padding inside the bottom edge of the element.

Node Output

Done

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

UI:LayoutGrid:GetSpacing Node

Gets the spacing (in pixels) between child elements of the LayoutGrid component for an element.

Node Inputs

Activate

Updates the output.

CanvasID

Unique identifier of the element's canvas.

ElementID

Unique identifier of the element.

Node Output

Spacing

A float value of the spacing (in pixels) between child elements of the element (ElementID).

UI:LayoutGrid:SetSpacing Node

Sets the spacing (in pixels) between child elements of the LayoutGrid component for an element.

Node Inputs

Activate

Updates the output.

CanvasID

Unique identifier of the element's canvas.

ElementID

Unique identifier of the element.

Spacing

A float value of the spacing (in pixels) between child elements of the element (ElementID).

Node Output

Done

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

UI:LayoutGrid:GetStartingDirection Node

Gets the starting direction for the layout.

Node Inputs

Activate

Updates the output.

CanvasID

Unique identifier of the element's canvas.

ElementID

Unique identifier of the element.

Node Output

Direction

An integer representing the direction.

Valid values: 0 = Horizontal order | 1 = Vertical order

UI:LayoutGrid:SetStartingDirection Node

Sets the starting direction for the layout.

Node Inputs

Activate

Set the starting direction for the layout.

CanvasID

Unique identifier of the element's canvas.

ElementID

Unique identifier of the element.

Direction

An integer representing the horizontal order.

Valid values: 0 = Horizontal order | 1 = Vertical order.

Node Output

Done

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

UI:LayoutGrid:GetVerticalOrder Node

Gets the vertical order for the layout.

Node Inputs

Activate

Updates the outputs.

CanvasID

Unique identifier of the element's canvas.

ElementID

Unique identifier of the element.

Node Output

Action

An integer representing the vertical order.

Valid values: 0 = Top to bottom | 1 = Bottom to top

UI:LayoutGrid:SetVerticalOrder Node

Sets the vertical order for the layout.

Node Inputs

Activate

Sets the vertical order for the layout.

CanvasID

Unique identifier of the element's canvas.

ElementID

Unique identifier of the element.

Action

An integer representing the vertical order.

Valid values: 0 = Top to bottom | 1 = Bottom to top

Node Output

Done

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