Menu
Lumberyard
Developer Guide (Version 1.11)

UICheckboxComponent

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

UiCheckboxBus

Services messages for the UiCheckboxComponent.

GetChangedActionName

Returns the action triggered when the check box value changes.

Syntax

Copy
AZStd::string & GetChangedActionName()

GetCheckedEntity

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

Syntax

Copy
AZ::EntityId GetCheckedEntity()

GetState

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

Syntax

Copy
bool GetState()

GetTurnOffActionName

Returns the action triggered when the check box is is cleared.

Syntax

Copy
const AZStd::string & GetTurnOffActionName()

GetTurnOnActionName

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

Syntax

Copy
const AZStd::string& GetTurnOnActionName()

GetUncheckedEntity

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

Syntax

Copy
AZ::EntityId GetUncheckedEntity()

SetChangedActionName

Sets the action triggered when the check box value changes.

Syntax

Copy
void SetChangedActionName(const AZStd::string& actionName)

SetCheckedEntity

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

Syntax

Copy
void SetCheckedEntity(AZ::EntityId entityId)

SetState

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

Syntax

Copy
void SetState(bool checked)

SetTurnOffActionName

Sets the action triggered when the check box is is cleared.

Syntax

Copy
void SetTurnOffActionName(const AZStd::string & actionName)

SetTurnOnActionName

Sets the action triggered when the check box is is selected.

Syntax

Copy
void SetTurnOnActionName(const AZStd::string & actionName)

SetUncheckedEntity

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

Syntax

Copy
void SetUncheckedEntity(AZ::EntityId entityId)

ToggleState

Toggles the state of the check box.

Syntax

Copy
bool ToggleState()

UiCheckboxNotificationBus

Services notifications for the UiCheckboxComponent.

OnCheckboxStateChange

Notifies that the check box state has changed.

Syntax

Copy
void OnCheckboxStateChange(bool checked)