Version:

UICheckboxComponent

You can use this component to implement a UI check box in Amazon Lumberyard.

UiCheckboxBus

Services messages for the UiCheckboxComponent.

Returns the action triggered when the check box value changes.

Syntax

AZStd::string & GetChangedActionName()

Returns the child element that is shown when the check box is selected.

Syntax

AZ::EntityId GetCheckedEntity()

Returns the state of the check box. True if selected; false otherwise.

Syntax

bool GetState()

Returns the action triggered when the check box is cleared.

Syntax

const AZStd::string & GetTurnOffActionName()

Returns the name of the action that is triggered when the check box is selected.

Syntax

const AZStd::string& GetTurnOnActionName()

Returns the child element that is shown when the check box is cleared.

Syntax

AZ::EntityId GetUncheckedEntity()

Sets the action triggered when the check box value changes.

Syntax

void SetChangedActionName(const AZStd::string& actionName)

Sets the child element to show when the check box is selected.

Syntax

void SetCheckedEntity(AZ::EntityId entityId)

Sets the state of the check box. True if selected; false otherwise.

Syntax

void SetState(bool checked)

Sets the action triggered when the check box is cleared.

Syntax

void SetTurnOffActionName(const AZStd::string & actionName)

Sets the action triggered when the check box is selected.

Syntax

void SetTurnOnActionName(const AZStd::string & actionName)

Sets the child element to show when the check box is cleared.

Syntax

void SetUncheckedEntity(AZ::EntityId entityId)

Toggles the state of the check box.

Syntax

bool ToggleState()

Services notifications for the UiCheckboxComponent.

Notifies that the check box state has changed.

Syntax

void OnCheckboxStateChange(bool checked)