Menu
Lumberyard
Legacy Reference

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

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

UI:Mask:GetDrawBehind Node

Gets whether mask is drawn behind the child elements.

Node Inputs

Activate

Updates the outputs.

CanvasID

Unique identifier of the element's canvas.

ElementID

Unique identifier of the element.

Node Output

DrawBehind

Indicates whether mask is drawn behind the child elements.

UI:Mask:SetDrawBehind Node

Sets whether mask is drawn behind the child elements.

Node Inputs

Activate

Sets whether mask is drawn behind the child elements.

CanvasID

Unique identifier of the element's canvas.

ElementID

Unique identifier of the element.

DrawBehind

Sets whether mask is drawn behind the child elements.

Node Output

Done

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

UI:Mask:GetDrawInFront Node

Gets whether mask is drawn in front of child elements.

Node Inputs

Activate

Updates the outputs.

CanvasID

Unique identifier of the element's canvas.

ElementID

Unique identifier of the element.

Node Output

DrawInFront

Indicates whether mask is drawn in front of child elements.

UI:Mask:SetDrawInFront Node

Sets whether mask is drawn in front of child elements.

Node Inputs

Activate

Sets whether mask is drawn in front of child elements.

CanvasID

Unique identifier of the element's canvas.

ElementID

Unique identifier of the element.

DrawInFront

Sets whether mask is drawn in front of child elements.

Node Output

Done

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

UI:Mask:GetIsMaskingEnabled Node

Gets whether masking is enabled.

Node Inputs

Activate

Updates the outputs.

CanvasID

Unique identifier of the element's canvas.

ElementID

Unique identifier of the element.

Node Output

IsMaskingEnabled

Indicates whether masking is enabled.

UI:Mask:SetIsMaskingEnabled Node

Sets whether masking is enabled.

Node Inputs

Activate

Sets whether masking is enabled.

CanvasID

Unique identifier of the element's canvas.

ElementID

Unique identifier of the element.

IsMaskingEnabled

Sets whether masking is enabled.

Node Output

Done

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

UI:Mask:GetUseAlphaTest Node

Gets whether to use the alpha channel in the mask visual's texture to define the mask.

Node Inputs

Activate

Updates the outputs.

CanvasID

Unique identifier of the element's canvas.

ElementID

Unique identifier of the element.

Node Output

UseAlphaTest

Indicates whether to use the alpha channel in the mask visual's texture to define the mask.

UI:Mask:SetUseAlphaTest Node

Sets whether to use the alpha channel in the mask visual's texture to define the mask.

Node Inputs

Activate

Sets whether to use the alpha channel in the mask visual's texture to define the mask.

CanvasID

Unique identifier of the element's canvas.

ElementID

Unique identifier of the element.

UseAlphaTest

Sets whether to use the alpha channel in the mask visual's texture to define the mask.

Node Output

Done

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