Template Node

Overview

• Node Name: Template Node
• Category: repeat_instant
• File: extensions/flowgraph/nodes/util/template.lua

A reference template demonstrating all available functionality for creating new flowgraph nodes. Not intended for production use - serves as documentation for node developers.

Pin Schema

Input Pins

Output Pins

Internals - Node Lifecycle

Category Reference

Lifecycle Methods

UI Methods

Serialization

How It Works

This node is a comprehensive reference. Key takeaways for node developers:

1. self.data fields are automatically serialized - no need to handle them manually.
2. Custom fields (like self.myField) need explicit _onSerialize/_onDeserialized.
3. Pin names flow and value are auto-hidden for cleaner display.
4. drawCustomProperties() should return a string reason to create an undo/redo history point.
5. C.dependencies lists required extensions for performance (avoids runtime lookups).

Usage Example

-- Creating a minimal new node:
local C = {}
C.name = 'My Node'
C.description = 'Does something useful.'
C.category = 'repeat_instant'

C.pinSchema = {
  {dir = 'in', type = 'number', name = 'value', default = 0, description = "Input value."},
  {dir = 'out', type = 'number', name = 'result', description = "Output result."},
}

C.tags = {'mynode'}

function C:work()
  self.pinOut.result.value = self.pinIn.value.value * 2
end

return _flowgraph_createNode(C)

Key Dependencies

• ui_imgui - ImGui bindings for custom UI
• _flowgraph_createNode() - node registration function

See Also

• Route Distance (Flowgraph Node) - Related reference
• Closest Road (Flowgraph Node) - Related reference
• Custom Lua (Flowgraph Node) - Related reference
• FlowGraph Guide - Guide