Menu
Lumberyard
Developer Guide (Version 1.11)

UiDropdownOptionComponent

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

Copy
AZ::EntityId GetOwningDropdown()

SetOwningDropdown

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

Syntax

Copy
void SetOwningDropdown(AZ::EntityId owningDropdown)

GetTextElement

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

Syntax

Copy
AZ::EntityId GetTextElement()

SetTextElement

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

Syntax

Copy
void SetTextElement(AZ::EntityId textElement)

GetIconElement

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

Syntax

Copy
AZ::EntityId GetIconElement()

SetIconElement

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

Syntax

Copy
void SetIconElement(AZ::EntityId iconElement)

UiDropdownOptionNotificationBus

Services notifications for the UiDropdownOptionComponent.

OnDropdownOptionSelected

Notifies that this dropdown option was selected.

Syntax

Copy
void OnDropdownOptionSelected()