Menu
Lumberyard
Legacy Reference

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

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

UI:Text:GetColor Node

Gets the color to draw the text string.

Node Inputs

Activate

Updates the outputs.

CanvasID

Unique identifier of the element's canvas.

ElementID

Unique identifier of the element.

Node Outputs

Color

The RGB value (0 – 255 each for R, G, and B) of the element identified by ElementID.

Alpha

The alpha value (0 – 255) of the element identified by ElementID.

UI:Text:SetColor Node

Sets the color to draw the text string.

Node Inputs

Activate

Updates the output.

CanvasID

Unique identifier of the element's canvas.

ElementID

Unique identifier of the element.

Color

The RGB value (0 – 255 each for R, G, and B) of the element identified by ElementID.

Alpha

The alpha value (0 – 255) of the element identified by ElementID.

Node Output

Done

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

UI:Text:GetFont Node

Gets the path to the font.

Node Inputs

Activate

Updates the output.

CanvasID

Unique identifier of the element's canvas.

ElementID

Unique identifier of the element.

Node Output

Font

The path to the font used by the element.

UI:Text:SetFontNode

Sets the path to the font.

Node Inputs

Activate

Updates the output.

CanvasID

Unique identifier of the element's canvas.

ElementID

Unique identifier of the element.

Font

The path to the font used by the element identified by ElementID.

Node Output

Done

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

UI:Text:GetFontSize Node

Gets the font size in points.

Node Inputs

Activate

Updates the output.

CanvasID

Unique identifier of the element's canvas.

ElementID

Unique identifier of the element.

Node Output

FontSize

The font size of the element identified by ElementID.

UI:Text:SetFontSize Node

Sets the font size in points.

Node Inputs

Activate

Updates the output.

CanvasID

Unique identifier of the element's canvas.

ElementID

Unique identifier of the element.

FontSize

The font size of the element identified by ElementID.

Node Output

Done

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

UI:Text:GetOverflowMode Node

Gets the overflow behavior of the text.

Node Inputs

Activate

Updates the output.

CanvasID

Unique identifier of the element's canvas.

ElementID

Unique identifier of the element.

Node Output

OverflowMode

An integer representing how overflow text is handled.

Valid values: 0 = Overflow text | 1 = Clip text

UI:Text:SetOverflowModeNode

Sets the overflow behavior of the text.

Node Inputs

Activate

Updates the output.

CanvasID

Unique identifier of the element's canvas.

ElementID

Unique identifier of the element.

OverflowMode

An integer representing how overflow text is handled.

Valid values: 0 = Overflow text | 1 = Clip text

Node Output

Done

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

UI:Text:GetText Node

Gets the text string that the element displays.

Node Inputs

Activate

Updates the output.

CanvasID

Unique identifier of the element's canvas.

ElementID

Unique identifier of the element.

Node Output

Value

The text string being displayed by the element identified by ElementID.

UI:Text:SetText Node

Sets the text string being displayed by the element.

Node Inputs

Activate

Updates the output.

CanvasID

Unique identifier of the element's canvas.

ElementID

Unique identifier of the element.

Value

The text string being displayed by the element identified by ElementID.

Node Output

Done

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

UI:Text:GetWrapText Node

Gets whether text is wrapped.

Node Inputs

Activate

Updates the output.

CanvasID

Unique identifier of the element's canvas.

ElementID

Unique identifier of the element.

Node Output

WrapTextSetting

An integer representing how long text lines are handled.

Valid values: 0 = No wrap | 1 = Wrap

UI:Text:SetWrapText Node

Gets whether text is wrapped.

Node Inputs

Activate

Updates the outputs.

CanvasID

Unique identifier of the element's canvas.

ElementID

Unique identifier of the element.

WrapTextSetting

An integer representing how long text lines are handled.

Valid values: 0 = No wrap | 1 = Wrap

Node Output

Done

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