Overlay Notification

Overlay Action

The Overlay action displays a text banner on the game screen. It supports countdown timers, optional images, and sticky behavior that keeps it visible until explicitly dismissed.

📷 Screenshot needed: The Overlay action panel showing all fields: message, background color, text color, time to live, countdown checkbox, sticky checkbox, image path, and ID field

📷 Screenshot needed: In-game example of an overlay banner with a countdown timer visible

---

Fields

Message

The text to display in the overlay. Supports capture group substitution with $1, $2, etc.

Background Color

The background color of the overlay banner.

Text Color

The color of the message text.

Time to Live (seconds)

How long the overlay is displayed before it disappears automatically.

• Set to 0 with Sticky unchecked to display briefly using a default duration.
• Ignored when Sticky is checked.

Count Down

When checked, the remaining time (from Time to Live) is displayed as part of the overlay, counting down to zero. Useful for reminders with a visible timer.

Sticky

When checked, the overlay remains on screen indefinitely and ignores the Time to Live value. It can only be dismissed by a Dismiss Overlay action targeting this overlay's ID, or by the user manually closing it.

Use sticky overlays for persistent reminders that should stay until a condition clears.

Image Path

Optional path to a local image file to display alongside the message. Leave blank for a text-only overlay.

Resize Image

When checked, the image is scaled to fit within the overlay bounds.

ID

A text identifier for this overlay. Used by the Dismiss Overlay action to target this specific overlay for dismissal. Required if you plan to use Dismiss Overlay to clear it programmatically.

---

Dismiss Pattern

A common pattern: one alert shows a sticky overlay when a condition becomes true, and a second alert uses a Dismiss Overlay action (with the same ID) to clear it when the condition resolves.

Example: show a sticky "Low prayer!" overlay when prayer drops below 20. When prayer recharges above 80, a second alert dismisses it.

See Dismiss Notifications for details.