Format String (Flowgraph Node)

Overview

• Node Name: Format String
• Category: repeat_instant
• File: extensions/flowgraph/nodes/string/format.lua

Formats a string using Lua's string.format with up to 16 input values.

Pin Schema

Input Pins

Output Pins

Data Properties

Behavior

• init() - Sets default pattern to "%d" and count to 1.
• postInit() - Creates initial input pins based on count.
• work() - Calls string.format(pattern, value_1, value_2, ...) with the current count of values. Uses a large if/elseif chain for 1–16 arguments.
• updatePins(old, new) - Adds or removes input pins when the count changes. Cleans up links to removed pins.

Properties Editor

• Count - Integer input to set how many value_N input pins exist (minimum 1, maximum 16).

Serialization

• _onSerialize(res) - Saves count.
• _onDeserialized(res) - Restores count and recreates pins.

How It Works

1. Set the pattern data property to a Lua format string.
2. Adjust the count to match the number of format placeholders.
3. Connect values to the value_1, value_2, etc. input pins.
4. The output value pin receives the formatted string each frame.

-- Example: pattern = "Player %s scored %d points"
-- value_1 = "Alice" (string)
-- value_2 = 42 (number)
-- Output: "Player Alice scored 42 points"

Limitations

• Maximum of 16 input values (hardcoded if/elseif chain).
• Uses Lua's standard string.format specifiers (%d, %s, %f, etc.).

Key Dependencies

• Lua built-in string.format

Additional Methods

C:drawCustomProperties()

Custom ImGui drawing for the node's properties panel in the editor.

C:drawMiddle(builder, style)

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

Parameters:

• builder
• style

See Also

• Match String (Flowgraph Node) - Related reference
• Concat (Flowgraph Node) - Related reference
• SubString (Flowgraph Node) - Related reference
• FlowGraph Guide - Guide