Messages Debugger

ImGui debug window for composing, sending, and clearing UI message events.

Overview

ui_messagesDebugger provides a developer-facing ImGui window to test the Message guihook system. You can compose messages with custom text, category, icon, and TTL, then send or clear them interactively.

Extension path: lua/ge/extensions/ui/messagesDebugger.lua Dependencies: ui_imgui

Exports (M)

Data Fields

Internals

UI State

• txtMsg - 1024-char buffer for message body
• txtCategory - 128-char buffer for category string
• txtIcon - 256-char buffer for icon path or font id
• ttlSeconds - Float slider (0.5–30s) for time-to-live
• useRegexClear - Checkbox to use regex when clearing categories
• bypassTtl - Checkbox to disable TTL (sends MessagesDebug event to UI)

Local Helpers

• _sendMessage(msg, ttl, category, icon) - Calls guihooks.message(...).
• _clearCategory(category, isRegex) - Triggers Message with clear = true.
• _clearAll() - Triggers ClearAllMessages.

Window Layout

The window contains:

1. Bypass TTL checkbox - sends MessagesDebug to the CEF layer
2. Multiline text input for the message body
3. Category and Icon inputs side-by-side
4. TTL slider (0.5–30 seconds)
5. Send Message / Send Binding Example buttons
6. Clear Category (with regex toggle) / Clear All buttons
7. Test 3 Messages - fires three messages with different categories

How It Works

1. Open via extensions.ui_messagesDebugger.show() or console.
2. Compose a message in the text area, set category/icon/TTL.
3. Click Send Message to fire guihooks.message(...).
4. Use Clear Category or Clear All to dismiss messages.
5. Send Binding Example demonstrates input-binding placeholders like [action=switch_next_vehicle].

Lua Examples

-- Open the debugger window
extensions.ui_messagesDebugger.show()

-- Toggle from console
extensions.ui_messagesDebugger.toggle()

Hooks Triggered

Additional Exports

The following exports are available but not yet documented in detail:

• M.hide
• M.onUpdate
• M.show
• M.toggle

See Also

• ui/ambientSound - Ambient Sound Stream Player - Related reference
• UI Apps Manager - Related reference
• UI Audio - Related reference
• UI System Guide - Guide