Play ScriptAI Recording

Overview

Node Name: Play ScriptAI Recording
Category: repeat_p_duration
File: extensions/flowgraph/nodes/vehicle/ai/scriptAI/playRecording.lua

Plays a ScriptAI recording from a file. Supports start/stop impulse control and loop count. Unlike "AI Follow Path from Data", this node loads the file directly by name.

Pin Schema

Input Pins

Pin	Type	Description
`start`	flow (impulse)	Starts playing the recording.
`stop`	flow (impulse)	Stops the recording.
`fileName`	string	Path to the `.track.json` file to load.
`vehId`	number	Vehicle to play recording on. Uses player vehicle if empty.
`loopCount`	number	Number of loops (-1 = infinite).

Internals

Key Methods

Method	Description
`init()`	Initializes with no recording, not running.
`postInit()`	Configures the fileName pin to accept `.track.json` files in the file browser.
`play()`	Loads the recording, sets loop count/type, sends `ai.startFollowing()`.
`stop()`	Sends `ai.stopFollowing()` and marks not running.
`loadRecording()`	Attempts multiple path resolutions for the file (relative, tracks dir, with/without extension).
`work()`	Dispatches `start` and `stop` impulses.
`drawMiddle()`	Shows recording info: vehicle, level, path count, duration, and optional debug path rendering.

Data Properties

Property	Default	Description
`renderDebug`	`false`	Draw path points and prisms in 3D viewport.

File Resolution Order

The node tries to load the file in this order:

Relative path from flowgraph manager
Relative path with .track.json extension appended
/replays/scriptai/tracks/ + filename
/replays/scriptai/tracks/ + filename + .track.json

How It Works

When start impulse fires, play() loads the recording JSON.
Sets loopCount and loopType = "firstOnlyTeleport" on the recording data.
Sends ai.startFollowing(recording) to the vehicle.
When stop impulse fires, sends ai.stopFollowing() to halt playback.

Usage Example

-- Flowgraph:
-- [Button Press] → start → [Play ScriptAI Recording (fileName="myTrack", loopCount=3)]
-- [Another Event] → stop ↗

-- Equivalent vehicle commands:
local data = jsonReadFile("/replays/scriptai/tracks/myTrack.track.json")
data.recording.loopCount = 3
data.recording.loopType = "firstOnlyTeleport"
veh:queueLuaCommand('ai.startFollowing(' .. serialize(data.recording) .. ')')

-- To stop:
veh:queueLuaCommand('ai.stopFollowing()')

Key Dependencies

ai.startFollowing() / ai.stopFollowing() - vehicle-side ScriptAI control
jsonReadFile() - JSON file loader
.track.json format - ScriptAI recording files

Overview

Node Name: Play ScriptAI Recording
Category: repeat_p_duration
File: extensions/flowgraph/nodes/vehicle/ai/scriptAI/playRecording.lua

Plays a ScriptAI recording from a file. Supports start/stop impulse control and loop count. Unlike "AI Follow Path from Data", this node loads the file directly by name.

Pin Schema

Input Pins

Pin	Type	Description
`start`	flow (impulse)	Starts playing the recording.
`stop`	flow (impulse)	Stops the recording.
`fileName`	string	Path to the `.track.json` file to load.
`vehId`	number	Vehicle to play recording on. Uses player vehicle if empty.
`loopCount`	number	Number of loops (-1 = infinite).

Internals

Key Methods

Method	Description
`init()`	Initializes with no recording, not running.
`postInit()`	Configures the fileName pin to accept `.track.json` files in the file browser.
`play()`	Loads the recording, sets loop count/type, sends `ai.startFollowing()`.
`stop()`	Sends `ai.stopFollowing()` and marks not running.
`loadRecording()`	Attempts multiple path resolutions for the file (relative, tracks dir, with/without extension).
`work()`	Dispatches `start` and `stop` impulses.
`drawMiddle()`	Shows recording info: vehicle, level, path count, duration, and optional debug path rendering.

Data Properties

Property	Default	Description
`renderDebug`	`false`	Draw path points and prisms in 3D viewport.

File Resolution Order

The node tries to load the file in this order:

Relative path from flowgraph manager
Relative path with .track.json extension appended
/replays/scriptai/tracks/ + filename
/replays/scriptai/tracks/ + filename + .track.json

How It Works

When start impulse fires, play() loads the recording JSON.
Sets loopCount and loopType = "firstOnlyTeleport" on the recording data.
Sends ai.startFollowing(recording) to the vehicle.
When stop impulse fires, sends ai.stopFollowing() to halt playback.

Usage Example

-- Flowgraph:
-- [Button Press] → start → [Play ScriptAI Recording (fileName="myTrack", loopCount=3)]
-- [Another Event] → stop ↗

-- Equivalent vehicle commands:
local data = jsonReadFile("/replays/scriptai/tracks/myTrack.track.json")
data.recording.loopCount = 3
data.recording.loopType = "firstOnlyTeleport"
veh:queueLuaCommand('ai.startFollowing(' .. serialize(data.recording) .. ')')

-- To stop:
veh:queueLuaCommand('ai.stopFollowing()')

Key Dependencies

ai.startFollowing() / ai.stopFollowing() - vehicle-side ScriptAI control
jsonReadFile() - JSON file loader
.track.json format - ScriptAI recording files

Play ScriptAI Recording

Overview

Pin Schema

Input Pins

Internals

Key Methods

Data Properties

File Resolution Order

How It Works

Usage Example

Key Dependencies

See Also

On this page

Play ScriptAI Recording

Overview

Pin Schema

Input Pins

Internals

Key Methods

Data Properties

File Resolution Order

How It Works

Usage Example

Key Dependencies

See Also

On this page