Lumberyard
Legacy Reference

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

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

UIe:Checkbox:GetState Node

Gets the Boolean state of the check box.

Node Inputs

Activate

Gets the state of the check box.

ElementName

Name of the check box element.

Node Output

State

Outputs the current Boolean state of the check box.

UIe:Checkbox:SetState Node

Sets the Boolean state of the check box.

Node Inputs

Activate

Sets the state of the check box.

ElementName

Name of the check box element.

State

The Boolean state of the check box.

Node Output

Done

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

UIe:Checkbox:GetChangedActionName Node

Gets the action triggered when the check box value changed.

Node Inputs

Activate

Gets the changed action name.

ElementName

Name of the check box element.

Node Output

ChangedAction

The action name string value emitted when the check box value changes.

UIe:Checkbox:SetChangedActionName Node

Sets the action triggered when the check box value changed.

Node Inputs

Activate

Gets the changed action name.

ElementName

Name of the check box element.

ChangedAction

The action name string value emitted when the check box value changes.

UIe:Checkbox:GetOptionalCheckedEntity Node

Gets the child element to show when the check box is in the on state.

Node Inputs

Activate

Updates the output.

ElementName

Name of the check box element.

Node Output

CheckedElement

The child element to show when the check box is selected (in the on state).

UIe:Checkbox:SetOptionalCheckedEntity Node

Sets the child element to show when the check box is selected (in the on state).

Node Inputs

Activate

Updates the output.

ElementName

Name of the check box element.

CheckedElement

The child element to show when the check box is selected (in the on state).

Node Output

Done

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

UIe:Checkbox:GetOptionalUncheckedEntity Node

Gets the child element to show when the check box is deselected (in the off state).

Node Inputs

Activate

Updates the output.

ElementName

Name of the check box element.

Node Output

UncheckedElement

The child element to show when the check box is deselected (off state).

UIe:Checkbox:SetOptionalUncheckedEntity Node

Sets the child element to show when the check box is deselected (in the off state).

Node Inputs

Activate

Updates the output.

ElementName

Name of the check box element.

UncheckedElement

The child element to show when the check box is deselected (in the off state).

Node Output

Done

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

UIe:Checkbox:GetTurnOnActionName Node

Gets the action triggered when the check box is selected.

Node Inputs

Activate

Updates the output.

ElementName

Name of the check box element.

Node Output

TurnOnAction

The action name emitted when the check box is selected (turned on).

UIe:Checkbox:SetTurnOnActionName Node

Sets the action triggered when the check box is selected (turned on).

Node Inputs

Activate

Assigns TurnOnAction as the action name that is emitted when the check box is selected.

ElementName

Name of the check box element.

TurnOnAction

The action name emitted when the check box is selected.

Node Output

Done

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

UIe:Checkbox:GetTurnOffActionName Node

Gets the action triggered when the check box is deselected (turned off).

Node Inputs

Activate

Update the output.

ElementName

Name of the check box element.

Node Output

TurnOffAction

The action name emitted when the check box is deselected.

UIe:Checkbox:SetTurnOffActionName Node

Sets the action triggered when the check box is deselected (turned off).

Node Inputs

Activate

Assigns TurnOffAction as the action name that is emitted when the check box is deselected.

ElementName

Name of the check box element.

TurnOffAction

The action name emitted when the check box is deselected.

Node Output

Done

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