Lightning

Environmental reference

FXMasterFilter effectAPI type: lightning

Full-scene lightning flashes with timing, tint, duration, and audio-aware controls.

Environmental filters change the Scene surface or atmosphere. They can cover the full Scene, be limited to Regions, and be moved within the effect stack.

Reference	Value
Package	FXMaster
Effect kind	Filter effect
Category	Environmental
Runtime type	lightning
Exposed parameters	17

Important controls

• Period: Sets the approximate time between automatic lightning flashes. Higher values create longer gaps between flashes.
• Duration: Sets how long each lightning flash remains visible before fading out.
• Brightness: Controls how strongly each lightning flash brightens the rendered scene.
• Audio Aware: Allows bass-heavy audio peaks to trigger Lightning. Use Audio Channels to choose what it listens to and Audio Bass Threshold to control sensitivity.
• Above Darkness: Presents the luminous contribution from Lightning above Foundry scene darkness. This option is available only on compatible luminous filters.

Setup notes

• Period controls the spacing between automatic events, while Duration controls each flash.
• Audio Aware can trigger from selected audio channels when the bass threshold is met.
• Keep Brightness conservative on already bright maps to avoid washing out large portions of the Scene.
• Above Darkness presents the luminous flash contribution above Foundry scene darkness.

Bundled preset usage

Preset	API name	Availability	Variants
Hurricane	hurricane	FXMaster, FXMaster+	Normal, Top Down
Thunderstorm	thunderstorm	FXMaster, FXMaster+	Normal, Top Down

Parameters

The table combines the settings available for this effect in Scene and Region contexts. Scene-only and Region-only badges identify controls limited to one context. Hover or focus an info button to see what the parameter changes on the canvas. Select it to keep the card open. Each card also includes the default, range or choices, context, availability, API key, and control type.

17 exposed parameters1 Scene-only1 Region-onlylightning API type

iHover or focus an info button to see what the parameter changes on the canvas. Select it to keep the card open. Context badges identify Scene-only and Region-only controls; unbadged parameters are available in both. Hover or focus an availability condition to highlight the parameter that controls it.

Parameter	Control	Default	Range or choices	Availability
Below Tokensi belowTokens	checkbox	Off	—	Always
Below Tilesi belowTiles	checkbox	Off	—	Always
Below Foregroundi belowForeground	checkbox	Off	—	Always
Levelsi levelsScene only	scene-levels	All Levels	—	Always
Tinti color	color	#ffffff (disabled)	—	Always
Sound FXi soundFxEnabled	checkbox	Off	—	Always
Sound FX Soundsi soundFxManualSoundIds	multi-select	Rule default	—	Shown when Sound FX = On and the matching enabled SoundFX rule uses Multi-Sound Mode = Manual with at least two configured sounds
Periodi frequency	range	5000	100–30000 · step 100	Shown when Audio Aware = Off
Durationi spark_duration	range	300	100–2000 · step 5	Always
Brightnessi brightness	range	1.3	0–4 · step 0.1	Always
Audio Awarei audioAware	checkbox	Off	—	Always
Audio Channelsi audioChannels	multi-select	Environment	Music, Environment, Interface	Shown when Audio Aware = On
Audio Bass Thresholdi audioBassThreshold	range	0.75	0–1 · step 0.01	Shown when Audio Aware = On
Above Darknessi aboveDarkness	checkbox	Off	—	Always
Darkness Activationi darknessActivationEnabled	checkbox	Off	—	Always
Darkness Activation Rangei darknessActivationRange	range-dual	{"min":0,"max":1}	0–1 · step 0.01	Shown when Darkness Activation = On
Edge Fade %i fadePercentRegion only	range	0	0–1 · step 0.01	Always

Direct-effect API example

The Direct Effect API creates a separate row shown through Manage API Effects. Add a stable apiMacro_…_p or apiMacro_…_f ID when later macro calls need to update or stop the same row.

const created = await FXMASTER.api.effects.play({
  filters: [{
    "id": "apiMacro_wikilightning_f",
    "type": "lightning",
    "options": {
      "color": {
        "apply": false,
        "value": "#ffffff"
      },
      "frequency": 0.5,
      "spark_duration": 0.5,
      "brightness": 1
    }
  }],
});

await FXMASTER.api.effects.filters.stop(created.filters);

For complete API behavior, scene targeting, stack ordering, and toggle groups, see the Direct Effect API guide.