API ReferenceGE Extensionsflowgraphnodesscenecamera
Start Cam Path (Flowgraph Node)
- **Node Name:** `Start Cam Path`
Overview
- Node Name:
Start Cam Path - Category:
once_instant - File:
extensions/flowgraph/nodes/scene/camera/startCamPath.lua
Starts playback of a camera path loaded from a .camPath.json file or created procedurally.
Pin Schema
Input Pins
| Pin | Type | Description |
|---|---|---|
pathName | string | Path name or file path to load the camera path from |
loop | bool | If the path should loop |
Output Pins
| Pin | Type | Description |
|---|---|---|
activated | flow (impulse) | Fires once when the path has been started |
id | number | Id of the started camera path |
Behavior
postInit()- Configures thepathNamepin to accept.camPath.jsonfiles in the file browser.workOnce()- Finds the path viaself.mgr.modules.camera:findPath(pathName), starts it withstartPath(id, loop), and outputs the path id. Sets theactivatedimpulse.work()- Manages theactivatedimpulse flag so it only fires for one frame.
Key Dependencies
self.mgr.modules.camera:findPath(name)- Resolves a path name to an internal idself.mgr.modules.camera:startPath(id, loop)- Begins camera path playback
How It Works
This is the primary node for initiating camera path playback. It accepts either a file path to a .camPath.json or a procedurally generated path name (from Procedural CamPath nodes). The activated impulse fires exactly once on the frame the path starts, then clears. The output id can be wired to Get Cam Path, Restart Cam Path, or Stop Cam Path nodes.
Example Usage
-- Start a camera path from file
-- Wire pathName = "levels/west_coast_usa/art/camera/intro.camPath.json"
-- Wire loop = true for continuous playback
-- Use the id output with Get Cam Path to monitor completionAdditional Methods
C:drawMiddle(builder, style)
Custom ImGui drawing in the middle section of the node in the editor.
Parameters:
builderstyle
See Also
- Camera Transform (Flowgraph Node) - Related reference
- Camera Look at Position (Flowgraph Node) - Related reference
- Camera Auto Circle (Flowgraph Node) - Related reference
- FlowGraph Guide - Guide