API ReferenceGE Extensionsflowgraphnodesscenecamera
Get Cam Path (Flowgraph Node)
- **Node Name:** `Get Cam Path`
Overview
- Node Name:
Get Cam Path - Category:
once_f_duration - File:
extensions/flowgraph/nodes/scene/camera/getCamPath.lua
Monitors the state of a camera path - whether it is active, complete, or inactive - and outputs duration and completion status. Used to track camera path playback within flowgraph scenarios.
Pin Schema
Input Pins
| Pin | Type | Description |
|---|---|---|
flow | flow | Inflow for this node |
reset | flow (impulse) | Resets the node state |
id | number | Id of the camera path. If not set, uses the currently active camera path |
Output Pins
| Pin | Type | Description |
|---|---|---|
flow | flow | Outflow for this node |
inactive | flow | Outflow if the campath is not active or no campath is running (hidden) |
complete | flow | Outflow if the campath is complete |
completed | flow (impulse) | Fires once when the campath completes (hidden) |
incomplete | flow | Outflow when the campath is active but not complete (hidden) |
duration | number | Duration of the path (hidden) |
Behavior
work()- Each frame, checks whether the specified (or currently active) camera path is active viaself.mgr.modules.camera.activePathId.- If inactive: sets
inactive= true,complete/completed/incomplete= false,duration= 0. - If active: queries
isPathComplete(id)andgetPathDuration(id)from the camera module. Fires thecompletedimpulse exactly once on transition to complete.
- If inactive: sets
resetpin - Triggers_executionStarted(), clearing thedoneandcompletedFlagstate.
Key Dependencies
self.mgr.modules.camera- Flowgraph camera module for path management (activePathId,isPathComplete(),getPathDuration())
How It Works
The node passes through the input flow and additionally monitors camera path state every frame. It uses an internal completedFlag to ensure the completed impulse pin fires only once when the path finishes. The reset impulse pin allows re-monitoring the same path.
Example Usage
-- In a flowgraph: wire a Start Cam Path node's id output into this node's id input
-- Then branch on complete/incomplete to trigger next scene actions
-- The completed impulse fires exactly once, useful for triggering one-shot eventsAdditional Methods
C:_executionStopped()
Called when graph execution stops. Used for cleanup.
C:drawMiddle(builder, style)
Custom ImGui drawing in the middle section of the node in the editor.
Parameters:
builderstyle
C:init()
Initializes the node, setting up pins and default properties.
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