---
title: "hud"
---

> Documentation Index
> Fetch the complete documentation index at: https://aesthetic-docs.pages.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# hud

Overlay output: vanilla titles, actionbar, and the mod's notification pills.

Titles and actionbar accept a [text component](/text) or a plain string.
Server-synced overlays (boss bars, tab list) are read via [`server`](/server).

| Function | What it does |
|----------|--------------|
| `hud.actionbar(t)` | Actionbar above the hotbar |
| `hud.title(t)` | Full-screen title (`hud.subtitle(t)` sets the line below) |
| `hud.title_times(i, s, o)` | Fade-in / stay / fade-out ticks (vanilla default `10, 70, 20`) |
| `hud.clear_title()` | Removes the current title immediately |
| `hud.notify(title, subtext?, kind?, duration?)` | Notification pill. `kind`: `"info"` (default), `"success"`, `"error"`. `duration` in seconds |

```lua
hud.title_times(5, 40, 10)
hud.subtitle("prepare yourself")
hud.title(text.literal("Round 2"):bold(true))
hud.notify("Saved", nil, "success")
```

Source: https://aesthetic-docs.pages.dev/hud/index.md
