Spawn Light / SpotLight (Flowgraph Node)

Overview

• Node Name: SpotLight
• Category: repeat_instant
• File: extensions/flowgraph/nodes/scene/spawnLight.lua

Creates and manages a spotlight in the scene with configurable position, rotation, color, and beam properties.

Pin Schema

Input Pins

Output Pins

Internals

Behavior

• work() - Each frame:
  • On clear, deletes all lights.
  • If fewer lights than maxObjectCount, creates a new one via createObject().
  • If exactly 1 light and update flow is active, updates all properties in place.
• createObject() - Uses worldEditorCppApi.createObject("SpotLight") and sets position, rotation, angles, brightness, range, and color.
• clearObjects() - Deletes all spawned lights and clears the list.

How It Works

1. On first trigger, creates a SpotLight via the world editor API (not createObject() - uses worldEditorCppApi).
2. The light is configured with all input properties and flagged as canSave = false.
3. When update flow is active with a single light, all properties are dynamically updated each frame.
4. Cleanup occurs on execution stop, mission end, or node destruction.

Key Dependencies

• worldEditorCppApi.createObject("SpotLight") - creates the light object
• editor.onAddSceneTreeObjects() / onRemoveSceneTreeObjects() - editor integration

Additional Methods

C:_executionStopped()

Called when graph execution stops. Used for cleanup.

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.

---

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