API ReferenceGE Extensionsflowgraphnodesui
RT Message (Flowgraph Node)
- **Node Name:** `RT Message`
Overview
- Node Name:
RT Message - Category:
repeat_instant - File:
extensions/flowgraph/nodes/ui/rtMessage.lua
Shows a real-time scenario message using the ScenarioRealtimeDisplay method. Unlike the regular Message node, this message persists until manually cleared - it does not auto-dismiss.
Pin Schema
Input Pins
| Pin | Type | Description |
|---|---|---|
message | any | Text to display. Can be a string or a table with txt and context fields |
clear | flow (impulse) | Clears the RT message |
How It Works
work()- Called every frame:- If
clearimpulse is active: sends an empty message{msg = ""}to clear the display. - If flow is active:
- If
messageis a table: extractstxtandcontextfields and sends them. - If
messageis a string/other: sends{msg = value}directly.
- If
- If
_executionStopped()- Automatically clears the message when the flowgraph stops.
The node uses a module-level messageData table that gets reused and cleared between calls for efficiency.
Lua Code Example
-- Show a realtime message:
guihooks.trigger('ScenarioRealtimeDisplay', { msg = "Keep your speed above 60 mph!" })
-- Show with context:
guihooks.trigger('ScenarioRealtimeDisplay', {
msg = "Time remaining: 30s",
context = { someKey = "someValue" }
})
-- Clear the message:
guihooks.trigger('ScenarioRealtimeDisplay', { msg = "" })Key Dependencies
guihooks.trigger('ScenarioRealtimeDisplay', data)- Persistent real-time message overlay
See Also
- Medal / Auto Medal (Flowgraph Node) - Related reference
- Clear Messages (Flowgraph Node) - Related reference
- Context Translation (Flowgraph Node) - Related reference
- FlowGraph Guide - Guide