Spawn Prefab (Flowgraph Node)

Overview

• Node Name: Spawn Prefab
• Category: (once behavior)
• File: extensions/flowgraph/nodes/scene/spawnPrefab.lua

Creates and manages a prefab in the scene. Supports .prefab.json and legacy .prefab formats. Spawns once and persists until reset or execution stop.

Pin Schema

Input Pins

Output Pins

Behavior

• work() - Each frame with flow:
  • Spawns the prefab on first trigger (once behavior).
  • On resetVeh impulse, restores all vehicle positions within the prefab.
  • Sets created impulse and success output on spawn.
• createObject() - Resolves the file path (trying .prefab and .prefab.json extensions), calls spawnPrefab(), adds to MissionGroup, and registers with the prefab module.

How It Works

1. Captures the current player vehicle ID before spawning (since prefab vehicles may steal focus).
2. Resolves the prefab path using mgr:getRelativeAbsolutePath() with fallback extensions.
3. Calls the engine spawnPrefab(name, file, pos, rot, scale, useGlobalTranslation).
4. The spawned object is flagged canSave = false and added to MissionGroup.
5. Registers with mgr.modules.prefab:addPrefab() for lifecycle tracking.
6. On cleanup, the objects list is cleared (prefab module handles actual deletion).

Example Usage

-- Spawn a traffic prefab at the origin:
-- path = "levels/west_coast_usa/scenarios/traffic_setup.prefab.json"
-- pos = {0, 0, 0}

Key Dependencies

• spawnPrefab(name, file, pos, rot, scale, globalTrans) - engine function
• self.mgr.modules.prefab:addPrefab() - registers prefab for lifecycle management
• self.mgr.modules.prefab:restoreVehiclePositions() - resets vehicles in prefab

Additional Methods

C:_executionStopped()

Called when graph execution stops. Used for cleanup.

C:clearObjects()

Node method.

C:destroy()

Destroys the node and cleans up any created objects.

C:init(mgr, ...)

Initializes the node, setting up pins and default properties.

Parameters:

• mgr
• ...

C:onClientEndMission()

Cleanup callback when the mission/level ends.

C:postInit()

Called after initialization is complete for additional setup.

See Also

• Collection Marker (Flowgraph Node) - Related reference
• Custom Lua Command (Flowgraph Node) - Related reference
• Get Object Field (Flowgraph Node) - Related reference
• FlowGraph Guide - Guide