Fix and improve ButtonMenuAction doc comment

This commit is contained in:
2025-08-14 20:54:29 -05:00
parent 8bf21e74f0
commit 4b70be7048

View File

@@ -83,10 +83,14 @@ struct MarkerGameOver;
#[derive(Component)] #[derive(Component)]
struct MarkerHUD; struct MarkerHUD;
/// Action specifier for the game-over menu's buttons. /// Action specifier for the buttons on the menus.
/// ///
/// Attach this component to a button and [`PluginGameOver`] will use it to /// Instead of holding function pointers for use as callbacks, I'm doing enum-
/// decide what to do when that button is pressed. /// dispatch. Add a variant according to what action the button press should
/// trigger.
///
/// Only [`PluginGameMenu`] and [`PluginGameOver`] will use it to this
/// component. There is no always-on, global system.
#[derive(Component)] #[derive(Component)]
enum ButtonMenuAction { enum ButtonMenuAction {
ToMainMenu, ToMainMenu,