Lumberyard
Legacy Reference

UI Element Node

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

Use the following flow graph nodes to perform actions on an element.

UI:Element:IsEnabled Node

Gets whether the element is enabled.

Node Inputs

Activate

Updates the outputs.

CanvasID

Unique identifier of the element's canvas.

ElementID

Unique identifier of the element.

Node Output

State

The enabled state of the element.

UI:Element:SetIsEnabled Node

Sets the Boolean enabled state of the element. If an element is not enabled, neither it nor any of its children are drawn or interactive.

Node Inputs

Activate

Sets the enabled state to the value of the State input.

CanvasID

Unique identifier of the element's canvas.

ElementID

Unique identifier of the element.

State

The Boolean enabled state of the element.

Node Output

Done

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

UI:Element:GetChildAtIndex Node

Gets the child of an element at the specified index.

Node Inputs

Activate

Updates the outputs.

CanvasID

Unique identifier of the element's canvas.

ElementID

Unique identifier of the element.

ChildIndex

The index of the child.

Node Output

ChildElementId

The element Id of the child element.

UI:Element:GetIndexOfChild Node

Gets the index of the specified child.

Node Inputs

Activate

Updates the outputs.

CanvasID

Unique identifier of the element's canvas.

ElementID

Unique identifier of the element.

ChildElementId

Unique identifier of the child element.

Node Output

IndexOfChild

The index of the child element.

UI:Element:GetNumChildElements Node

Gets the number of children of an element.

Node Inputs

Activate

Updates the outputs.

CanvasID

Unique identifier of the element's canvas.

ElementID

Unique identifier of the element.

Node Output

NumChildElements

The number of child elements.

UI:Element:GetParent Node

Gets the parent of an element.

Node Inputs

Activate

Updates the outputs.

CanvasID

Unique identifier of the element's canvas.

ElementID

Unique identifier of the element.

Node Output

ParentElementId

The element Id of the parent element.