UiRadioButtonComponent - Lumberyard User Guide

UiRadioButtonComponent

Open 3D Engine (O3DE), the successor to Lumberyard, is now available in Developer Preview. Download O3DE or visit the AWS Game Tech blog to learn more.

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

bool GetState()

GetGroup

Returns the group of the radio button.

Syntax

AZ::EntityId GetGroup()

GetCheckedEntity

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

Syntax

AZ::EntityId GetCheckedEntity()

SetCheckedEntity

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

Syntax

void SetCheckedEntity(AZ::EntityId entityId)

GetUncheckedEntity

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

Syntax

AZ::EntityId GetUncheckedEntity()

SetUncheckedEntity

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

Syntax

void SetUncheckedEntity(AZ::EntityId entityId)

GetTurnOnActionName

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

Syntax

const AZStd::string& GetTurnOnActionName()

SetTurnOnActionName

Sets the action triggered when the radio button is selected.

Syntax

void SetTurnOnActionName(const AZStd::string & actionName)

GetTurnOffActionName

Returns the action triggered when the radio button is cleared.

Syntax

const AZStd::string & GetTurnOffActionName()

SetTurnOffActionName

Sets the action triggered when the radio button is cleared.

Syntax

void SetTurnOffActionName(const AZStd::string & actionName)

GetChangedActionName

Returns the action triggered when the radio button value changes.

Syntax

AZStd::string & GetChangedActionName()

SetChangedActionName

Sets the action triggered when the radio button value changes.

Syntax

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

void SetState(bool checked)

SetGroup

Sets the group of the radio button.

Syntax

void SetGroup(AZ:EntityId group)

UiRadioButtonNotificationBus

Services notifications for the UiRadioButtonComponent.

OnRadioButtonStateChange

Notifies that the radio button state has changed.

Syntax

void OnRadioButtonStateChange(bool checked)