helios/engine/modules/ui/widgets/commands/README.md File

Namespaces Index

namespace	commands
	UI action commands. More...

File Listing

The file content with the documentation metadata removed is:

 # helios::engine::modules::ui::widgets::commands

 

 UI action commands.

 

 This namespace contains commands for triggering UI actions.

 

 ## Commands

 

 | Command | Description |

 |---------|-------------|

 | `UiActionCommand` | Encapsulates a UI action request with source entity and action ID |

 

 

 

 ## UiActionCommand

 

 A world command created when a UI element is activated (e.g., button pressed, menu item selected). Carries the source entity and an `ActionId` that identifies the action to execute.

 

 Commands are routed through the `CommandHandlerRegistry` to the registered `UiActionCommandManager`.

 

 ## Usage

 

 ```cpp

 // Issue a UI action command when menu item is activated

 updateContext.queueCommand<UiActionCommand>(

  menuItemEntity.entityHandle(),

  ActionId::StartGame

 );

 ```

 

 ---

 

 <details>

 <summary>Doxygen</summary><p>

 @namespace helios::engine::modules::ui::widgets::commands

 @brief UI action commands.

 @details Contains commands for triggering UI actions that route them to registered handlers.

 </p></details>

 

---

Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.15.0.