Receive Message (Flowgraph Node)

Overview

• Node Name: Receive Message
• Category: (default)
• File: extensions/flowgraph/nodes/thread/receiveMessage.lua

Receives a message from another running flowgraph project. Used for inter-project communication.

Pin Schema

Input Pins

Custom input pins can be added (supports string, number, bool, any, table, vec3, quat, color).

Output Pins

Custom output pins can be added to extract message data fields.

Behavior

• init() - Enables pin saving and custom output pins.
• onThreadMessageProcess(message) - Captures the incoming message (if not already done).
• work() - When flow is active, name is set, and a message exists:
  • Copies message fields to matching output pins
  • Sets receiving impulse for one frame
  • Sets received to true permanently
  • Marks as done (won't receive again until reset)
• Reset - The reset impulse clears done, receiving, and received flags.

How It Works

1. Set the name filter to match the expected message name.
2. Add custom output pins matching the data fields you expect.
3. When a message arrives, receiving fires for one frame and data appears on output pins.
4. Use reset to allow receiving another message.

-- Sender project sends: { name = "score_update", score = 100 }
-- Receiver has: name = "score_update", custom out pin "score"
-- On receive: pinOut.score = 100, receiving = true (one frame)

Key Dependencies

• self.mgr.modules.thread - Thread module delivers messages

Additional Methods

C:_executionStarted()

Called when graph execution starts. Used for initialization/reset.

C:drawMiddle(builder, style)

Custom ImGui drawing in the middle section of the node in the editor.

Parameters:

• builder
• style

See Also

• Load Project (Flowgraph Node) - Related reference
• Send Message (Flowgraph Node) - Related reference
• FlowGraph Guide - Guide