Menu
Lumberyard
Legacy Reference

UIe Canvas 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.

You can use these flow graph nodes to perform actions on a UI canvas.

UIe:Canvas:ActionListener Node

Listens for the specified action on a UI canvas.

Node Inputs

Activate

Initiates listening for the specified action.

ActionName

Name of the action to listen for.

Node Outputs

OnAction

Triggers when the canvas sends the action.

ElementName

Name of the UI element that triggered the action.

ElementId

The element Id of the fader element. Used if ElementName is empty.

UIe:Canvas:LoadIntoEntity Node

Loads the specified UI canvas.

Node Inputs

Activate

Loads the canvas.

Disabled

Sets whether canvas is disabled initially. If disabled, the canvas is not updated or rendered.

Node Outputs

OnLoad

Sends a signal when the canvas is loaded.

UIe:Canvas:UnloadFromEntity Node

Unloads the specified canvas.

Node Inputs

Activate

Unloads the canvas.

Node Output

Done

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

UIe:Canvas:GetKeepLoaded Node

Gets the Boolean value of whether the canvas stays loaded when a level is unloaded.

Node Inputs

Activate

Gets whether the canvas stays loaded when the level is unloaded.

Node Output

KeepLoaded

The Boolean value of whether the canvas stays loaded if the level is unloaded. True if the canvas should stay loaded during level unload; otherwise, false.

UIe:Canvas:SetKeepLoaded Node

Determines whether the canvas stays loaded when a level is unloaded.

Node Inputs

Activate

Sets whether the canvas stays loaded when the level is unloaded.

KeepLoaded

If true, causes the canvas to stay loaded when the level is unloaded.

Node Output

Done

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

UIe:Canvas:GetDrawOrder Node

Gets the integer draw order value for a UI canvas with respect to other UI canvases.

Node Inputs

Activate

Gets the draw order for the canvas.

Node Output

DrawOrder

Order in which the canvas draws. Higher numbers appear before lower numbers.

UIe:Canvas:SetDrawOrder Node

Sets the draw order for a UI canvas with respect to other UI canvases.

Node Inputs

Activate

Sets the draw order for the canvas.

DrawOrder

Order in which to display the canvas. Higher numbers appear before lower numbers.

Node Output

Done

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

UIe:Canvas:GetIsPixelAligned Node

Gets the Boolean value of whether the canvas is pixel-aligned.

Node Inputs

Activate

Gets whether visual element's vertices should snap to the nearest pixel.

Node Output

IsPixelAligned

Boolean value. True if the visual element's vertices should snap to the nearest pixel; otherwise, false.

UIe:Canvas:SetIsPixelAligned Node

Sets whether visual element's vertices should snap to the nearest pixel.

Node Inputs

Activate

Sets the pixel-aligned property for the canvas ID.

IsPixelAligned

Boolean value that represents whether a visual element's vertices should snap to the nearest pixel.

Node Output

Done

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

UIe:Canvas:GetEnabled Node

Gets the Boolean enabled flag of the canvas. Enabled canvases are updated and each frame rendered.

Node Inputs

Activate

Gets the enabled flag of the canvas.

Node Output

Enabled

The enabled flag of the canvas. True if enabled; otherwise, false.

UIe:Canvas:SetEnabled Node

Sets whether the canvas is enabled. Enabled canvases are updated and each frame rendered.

Node Inputs

Activate

Sets the enabled flag of the canvas.

Enabled

True if the canvas should be enabled; otherwise, false.

Node Output

Done

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