Lumberyard
Legacy Reference

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

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

UI:TextInput:GetChangeAction Node

Gets the action triggered when the text is changed.

Node Inputs

Activate

Updates the output.

CanvasID

Unique identifier of the element's canvas.

ElementID

Unique identifier of the element.

Node Output

ChangeAction

The action name.

UI:TextInput:SetChangeAction Node

Sets the action triggered when the text is changed.

Node Inputs

Activate

Updates the output.

CanvasID

Unique identifier of the element's canvas.

ElementID

Unique identifier of the element.

ChangeAction

The action name.

Node Output

Done

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

UI:TextInput:GetCursorBlinkInterval Node

Gets the cursor blink interval of the text input.

Node Inputs

Activate

Updates the output.

CanvasID

Unique identifier of the element's canvas.

ElementID

Unique identifier of the element.

Node Output

CursorBlinkInterval

The cursor blink in interval of the element identified by ElementID.

UI:TextInput:SetCursorBlinkInterval Node

Gets the cursor blink interval of the text input.

Node Inputs

Activate

Updates the output.

CanvasID

Unique identifier of the element's canvas.

ElementID

Unique identifier of the element.

CursorBlinkInterval

The cursor blink in interval of the element identified by ElementID.

Node Output

Done

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

UI:TextInput:GetEndEditAction Node

Gets the action triggered when the editing of text is finished.

Node Inputs

Activate

Updates the output.

CanvasID

Unique identifier of the element's canvas.

ElementID

Unique identifier of the element.

Node Output

EndEditAction

The action name.

UI:TextInput:SetEndEditAction Node

Sets the action triggered when the editing of text is finished.

Node Inputs

Activate

Updates the output.

CanvasID

Unique identifier of the element's canvas.

ElementID

Unique identifier of the element.

EndEditAction

The action name.

Node Output

Done

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

UI:TextInput:GetEnterAction Node

Gets the action triggered when Enter is pressed.

Node Inputs

Activate

Updates the output.

CanvasID

Unique identifier of the element's canvas.

ElementID

Unique identifier of the element.

Node Output

EnterAction

The action name.

UI:TextInput:SetEnterAction Node

Sets the action triggered when Enter is pressed.

Node Inputs

Activate

Updates the output.

CanvasID

Unique identifier of the element's canvas.

ElementID

Unique identifier of the element.

EnterAction

The action name.

Node Output

Done

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

UI:TextInput:GetIsPasswordField Node

Gets whether the text input is configured as a password field.

Node Inputs

Activate

Updates the output.

CanvasID

Unique identifier of the element's canvas.

ElementID

Unique identifier of the element.

Node Output

IsPasswordField

Boolean. Whether the element identified by ElementID is configured as a password field.

UI:TextInput:SetIsPasswordField Node

Sets whether the text input is configured as a password field.

Node Inputs

Activate

Updates the output.

CanvasID

Unique identifier of the element's canvas.

ElementID

Unique identifier of the element.

IsPasswordField

Boolean. Whether the element identified by ElementID is configured as a password field.

Node Output

Done

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

UI:TextInput:GetMaxStringLength Node

Gets the maximum number of characters that can be entered.

Node Inputs

Activate

Updates the output.

CanvasID

Unique identifier of the element's canvas.

ElementID

Unique identifier of the element.

Node Output

MaxStringLength

An integer representing the maximum number of characters that can be entered.

Valid values: 0 = none allowed | -1 = unlimited

UI:TextInput:SetMaxStringLength Node

Sets the maximum number of characters that can be entered.

Node Inputs

Activate

Updates the output.

CanvasID

Unique identifier of the element's canvas.

ElementID

Unique identifier of the element.

MaxStringLength

An integer representing the maximum number of characters that can be entered.

Valid values: 0 = none allowed | -1 = unlimited

Node Output

Done

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

UI:TextInput:GetPlaceHolderTextEntity Node

Gets the placeholder text element.

Node Inputs

Activate

Updates the output.

CanvasID

Unique identifier of the element's canvas.

ElementID

Unique identifier of the element.

Node Output

PlaceHolderTextElement

The placeholder text element.

UI:TextInput:SetPlaceHolderTextEntity Node

Sets the placeholder text element.

Node Inputs

Activate

Updates the output.

CanvasID

Unique identifier of the element's canvas.

ElementID

Unique identifier of the element.

PlaceHolderTextElement

The placeholder text element.

Node Output

Done

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

UI:TextInput:GetText Node

Gets the text string that the element is displaying or allowing to be edited.

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 or edited by the element

UI:TextInput:SetText Node

Sets the text string that the element is displaying or allowing to be edited.

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 or edited by the element

Node Output

Done

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

UI:TextInput:GetTextCursorColor Node

Gets the color to be used for the text cursor.

Node Inputs

Activate

Updates the output.

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:TextInput:SetTextCursorColor Node

Sets the color to be used for the text cursor.

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:TextInput:GetTextEntity Node

Gets the text element.

Node Inputs

Activate

Updates the output.

CanvasID

Unique identifier of the element's canvas.

ElementID

Unique identifier of the element.

Node Output

TextElement

The text element.

UI:TextInput:SetTextEntity Node

Gets the text element.

Node Inputs

Activate

Updates the output.

CanvasID

Unique identifier of the element's canvas.

ElementID

Unique identifier of the element.

TextElement

The text element.

Node Output

Done

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

UI:TextInput:GetTextSelectionColor Node

Gets the color to be used for the text background when it is selected.

Node Inputs

Activate

Updates the output.

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:TextInput:SetTextSelectionColor Node

Gets the color to be used for the text background when it is selected.

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