Custom Lua Command (Flowgraph Node)

Overview

• Node Name: Custom Lua Command
• Category: once_instant
• File: extensions/flowgraph/nodes/scene/customLuaCommand.lua

Executes an arbitrary Lua string within the flowgraph and optionally captures the return value.

Pin Schema

Input Pins

Output Pins

Behavior

• init() - Sets clearOutPinsOnStart = false to preserve the return value across frames.
• _executionStarted() - Clears the return output pin.
• workOnce() - If func has a value:
  1. Compiles the string with loadstring(func).
  2. Executes it safely with pcall().
  3. Sets flow output to the pcall success status.
  4. Sets return output to the return value.
• _onDeserialized() - Handles legacy data format where func was stored in data.func, migrating it to a hardcoded pin.

Key Dependencies

• loadstring() - Compiles a Lua string into a callable function
• pcall() - Protected call for safe execution

How It Works

This is the escape hatch node - it lets flowgraph authors run arbitrary GE Lua code. The code string is compiled and executed in a protected call, so errors won't crash the flowgraph (they'll just set flow to false). The return value is captured and can be wired to other nodes.

Example Usage

-- Execute arbitrary Lua from flowgraph
-- func = "return be:getObjectCount()"
-- The return pin will contain the object count

-- Side effects work too
-- func = "log('I', 'fg', 'Hello from flowgraph!')"

-- Access any GE API
-- func = "return core_vehicles.getCurrentVehicleDetails()"

See Also

• Collection Marker (Flowgraph Node) - Related reference
• Get Object Field (Flowgraph Node) - Related reference
• Get Player Vehicle ID (Flowgraph Node) - Related reference
• FlowGraph Guide - Guide