UiDropdownOptionComponent - Lumberyard User Guide

UiDropdownOptionComponent

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 UiDropdownOptionComponent to implement a dropdown options for a UI element in Amazon Lumberyard.

UiDropdownOptionBus

Services messages for the UiDropdownOptionComponent.

GetOwningDropdown

Returns the owning dropdown to be modified when this dropdown option is selected.

Syntax

AZ::EntityId GetOwningDropdown()

SetOwningDropdown

Sets the owning dropdown to be modified when this dropdown option is selected.

Syntax

void SetOwningDropdown(AZ::EntityId owningDropdown)

GetTextElement

Returns the text element that is used to display this dropdown option’s text.

Syntax

AZ::EntityId GetTextElement()

SetTextElement

Sets the text element that is used to display this dropdown option’s text.

Syntax

void SetTextElement(AZ::EntityId textElement)

GetIconElement

Returns the icon element that is used to display this dropdown option’s icon.

Syntax

AZ::EntityId GetIconElement()

SetIconElement

Sets the icon element that is used to display this dropdown option’s icon.

Syntax

void SetIconElement(AZ::EntityId iconElement)

UiDropdownOptionNotificationBus

Services notifications for the UiDropdownOptionComponent.

OnDropdownOptionSelected

Notifies that this dropdown option was selected.

Syntax

void OnDropdownOptionSelected()