Menu
Lumberyard
Developer Guide (Version 1.11)

UiRadioButtonComponent

You can use UiRadioButtonComponent to implement a UI radio button in Amazon Lumberyard.

UiRadioButtonBus

Services messages for the UiRadioButtonComponent.

GetState

Returns the state of the radio button. True if selected; false otherwise.

Syntax

Copy
bool GetState()

GetGroup

Returns the group of the radio button.

Syntax

Copy
AZ::EntityId GetGroup()

GetCheckedEntity

Returns the child element that is shown when the radio button is selected.

Syntax

Copy
AZ::EntityId GetCheckedEntity()

SetCheckedEntity

Sets the child element to show when the radio button is selected.

Syntax

Copy
void SetCheckedEntity(AZ::EntityId entityId)

GetUncheckedEntity

Returns the child element that is shown when the radio button is cleared.

Syntax

Copy
AZ::EntityId GetUncheckedEntity()

SetUncheckedEntity

Sets the child element to show when the radio button is cleared.

Syntax

Copy
void SetUncheckedEntity(AZ::EntityId entityId)

GetTurnOnActionName

Returns the name of the action that is triggered when the radio button is selected.

Syntax

Copy
const AZStd::string& GetTurnOnActionName()

SetTurnOnActionName

Sets the action triggered when the radio button is selected.

Syntax

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

GetTurnOffActionName

Returns the action triggered when the radio button is cleared.

Syntax

Copy
const AZStd::string & GetTurnOffActionName()

SetTurnOffActionName

Sets the action triggered when the radio button is cleared.

Syntax

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

GetChangedActionName

Returns the action triggered when the radio button value changes.

Syntax

Copy
AZStd::string & GetChangedActionName()

SetChangedActionName

Sets the action triggered when the radio button value changes.

Syntax

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

UiRadioButtonCommunicationBus

Allows communication between the radio button group and a radio button.

SetState

Sets the state of the radio button. True if selected; false otherwise.

Syntax

Copy
void SetState(bool checked)

SetGroup

Sets the group of the radio button.

Syntax

Copy
void SetGroup(AZ:EntityId group)

UiRadioButtonNotificationBus

Services notifications for the UiRadioButtonComponent.

OnRadioButtonStateChange

Notifies that the radio button state has changed.

Syntax

Copy
void OnRadioButtonStateChange(bool checked)