Open 3D Engine AzToolsFramework API Reference 23.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Public Member Functions | Public Attributes | List of all members
AzToolsFramework::ActionProperties Struct Reference

#include <ActionManagerInterface.h>

Public Member Functions

 AZ_RTTI (ActionProperties, "{B84A0BDD-4D15-4078-B6AE-240F825358F7}")
 

Public Attributes

AZStd::string m_name
 The friendly name for the Action. Used in menu items and tooltips.
 
AZStd::string m_description
 The description for the Action.
 
AZStd::string m_category
 The category for the Action to be used in UI.
 
AZStd::string m_iconPath
 
AZStd::vector< AZStd::string > m_modes
 
ActionVisibility m_menuVisibility = ActionVisibility::HideWhenDisabled
 Determines visibility for this action in Menus.
 
ActionVisibility m_toolBarVisibility = ActionVisibility::OnlyInActiveMode
 Determines visibility for this action in ToolBars.
 

Detailed Description

Action Properties object. Used to streamline registration of an Action.

Member Data Documentation

◆ m_iconPath

AZStd::string AzToolsFramework::ActionProperties::m_iconPath

The qrc path to the icon to be used in UI.

◆ m_modes

AZStd::vector<AZStd::string> AzToolsFramework::ActionProperties::m_modes

Determines in which mode this action should be accessible. Empty means action will always appear regardless of the mode.

The documentation for this struct was generated from the following file: