Skip to content

SusHudMenuButton

SusHudMenuButton

Compact HUD escape / pause entry — tonal secondary button with native tooltip.

Package

SusGame · HUD (commercial)

Open in Playground

SusGame · HUD

Props

NameTypeDefault
LabelProp<string>""
TooltipProp<string>"Menu"
ShowInventoryProp<bool>false
ShowShopProp<bool>false
InventoryTooltipProp<string>"Inventory"
ShopTooltipProp<string>"Shop"

Slots

No slots.

Events

NameFieldPayload
MenuClickedOnMenuClicked
InventoryClickedOnInventoryClicked
ShopClickedOnShopClicked

Style hooks

USS class contract — override appearance without touching C#. States toggle via these classes:

  • sus-button--size-sm
  • sus-hud-menu-button
  • sus-hud-menu-button__btn
  • sus-hud-menu-button__quick
  • sus-hud-menu-button__quick--inventory
  • sus-hud-menu-button__quick--shop
  • sus-hud-menu-button--with-inventory
  • sus-hud-menu-button--with-shop

Usage

csharp
var menu = new SusHudMenuButton();
menu.Label.Value = "☰";
menu.Tooltip.Value = "Menu";
menu.OnMenuClicked += () => { /* open escape / settings */ };
// or: menu.ApplyData("☰");
xml
<template>
  <sus:SusHudMenuButton :Label="Label.Value"
                        :Tooltip="Tip.Value"
                        @menu-clicked="OnMenuClicked" />
</template>

<script>
public Prop<string> Label = new("☰");
public Prop<string> Tip = new("Menu");
void OnMenuClicked() { /* … */ }
</script>
Prop / APIRole
LabelButton text (default )
TooltipUITK native tooltip (default Menu)
ApplyData(label?)Batch label update
OnMenuClickedClick

Notes

  • Empty label falls back to .
  • Place in HUD chrome corner; pair with escape / settings modal flow, not a full menu panel.