UICheckboxComponent
You can use this component to implement 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
AZStd::string & GetChangedActionName()
GetCheckedEntity
Returns the child element that is shown when the check box is selected.
Syntax
AZ::EntityId GetCheckedEntity()
GetState
Returns the state of the check box. True if selected; false otherwise.
Syntax
bool GetState()
GetTurnOffActionName
Returns the action triggered when the check box is cleared.
Syntax
const AZStd::string & GetTurnOffActionName()
GetTurnOnActionName
Returns the name of the action that is triggered when the check box is selected.
Syntax
const AZStd::string& GetTurnOnActionName()
GetUncheckedEntity
Returns the child element that is shown when the check box is cleared.
Syntax
AZ::EntityId GetUncheckedEntity()
SetChangedActionName
Sets the action triggered when the check box value changes.
Syntax
void SetChangedActionName(const AZStd::string& actionName)
SetCheckedEntity
Sets the child element to show when the check box is selected.
Syntax
void SetCheckedEntity(AZ::EntityId entityId)
SetState
Sets the state of the check box. True if selected; false otherwise.
Syntax
void SetState(bool checked)
SetTurnOffActionName
Sets the action triggered when the check box is cleared.
Syntax
void SetTurnOffActionName(const AZStd::string & actionName)
SetTurnOnActionName
Sets the action triggered when the check box is selected.
Syntax
void SetTurnOnActionName(const AZStd::string & actionName)
SetUncheckedEntity
Sets the child element to show when the check box is cleared.
Syntax
void SetUncheckedEntity(AZ::EntityId entityId)
ToggleState
Toggles the state of the check box.
Syntax
bool ToggleState()
UiCheckboxNotificationBus
Services notifications for the UiCheckboxComponent.
OnCheckboxStateChange
Notifies that the check box state has changed.
Syntax
void OnCheckboxStateChange(bool checked)
