Custom Vehicle Lua

Overview

• Node Name: Custom Vehicle Lua
• Category: repeat_p_duration
• File: extensions/flowgraph/nodes/vehicle/special/customVlua.lua

Calls a custom vehicle Lua function on each tick. Sends arbitrary Lua code to a vehicle's Lua environment via queueLuaCommand.

Pin Schema

Input Pins

Output Pins

Legacy Pin Mapping

• in.vehicleId → vehId
• out.vehicleId → vehId

Internals

Key Methods

Deserialization Migration

If the node was serialized with data.func (legacy format), it migrates the value to a hardcoded pin:

data.hardcodedPins = {
  func = { value = data.data.func, type = 'string' }
}

How It Works

1. On each tick, resolves the vehicle by vehId or falls back to getPlayerVehicle(0).
2. If both vehicle and func are valid, calls veh:queueLuaCommand(func).
3. The Lua string is executed in the vehicle's Lua environment on the next frame.
4. Outputs the vehicle ID on vehId.

Usage Example

-- In a flowgraph - activate hazard lights on a vehicle:
-- [Vehicle ID] → [Custom Vehicle Lua].vehId
-- [String: "electrics.setLightsState({hazard_enabled = 1})"] → [Custom Vehicle Lua].func

-- In a flowgraph - lock the parking brake:
-- [String: "input.event('parkingbrake', 1, 1)"] → [Custom Vehicle Lua].func

-- Direct Lua equivalent:
local veh = getPlayerVehicle(0)
veh:queueLuaCommand("electrics.setLightsState({hazard_enabled = 1})")

Key Dependencies

• veh:queueLuaCommand(luaString) - sends arbitrary Lua to the vehicle environment
• scenetree.findObjectById() - resolves vehicle by ID
• getPlayerVehicle(0) - gets the current player vehicle

See Also

• Get Custom Vehicle Value (Flowgraph Node) - Related reference
• Custom vlua - Deprecated (Flowgraph Node) - Related reference
• Vehicle Action (Flowgraph Node) - Related reference
• FlowGraph Guide - Guide