Aurora Borealis

Environmental reference

FXMaster+Filter effectAPI type: auroraborealis

Preview

Preview shows Aurora Borealis being played in Horizon mode

Map maker

Map:Cze & Peku

Aurora curtains in side, top-down, or horizon presentations with palettes, haze, and motion 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	auroraborealis
Exposed parameters	34

Presentation modes

Aurora Borealis has three presentation modes. Choose the mode before tuning shared ribbon controls because each mode exposes a different placement group.

Mode	Presentation	Main placement controls
Side	A vertical curtain across a landscape or side-facing Scene	Curtain Height Position and Curtain Falloff
Top Down	An overhead ribbon path	Path Angle, Depth Glow, and Haze Strength
Horizon	A lower, distant aurora path	Start Anchor, Exit Anchor, Overhead Drop, Path Slant, Haze Strength, and Haze Height

Palettes and ribbons

Built-in palettes provide coordinated color sets. Custom Colors exposes five separate color controls plus Mixed Colors.

The shared ribbon controls are Aurora Count, Intensity, Speed, Ribbon Width, Waviness, and Softness. Increase Aurora Count or Ribbon Width when more of the view should be filled, but raising both heavily can flatten the separation between ribbons.

Important controls

• Aurora Mode: Selects the Side, Top-Down, or Horizon presentation. Each mode changes how the aurora is positioned and which controls are available.
• Aurora Palette: Selects a built-in five-color aurora palette or enables the custom color controls.
• Aurora Count: Sets how many separate aurora ribbons are rendered at once.
• Intensity: Controls the brightness and opacity of the aurora ribbons.
• Ribbon Width: Changes the width of each aurora ribbon.
• Waviness: Controls how strongly the aurora ribbons bend and undulate along their length.
• Softness: Controls how soft the ribbon edges and internal folds appear.

Setup notes

• Aurora Mode selects Side, Top Down, or Horizon presentation, each with its own placement controls.
• Built-in palettes provide coordinated colors. Custom Colors exposes five color slots and Mixed Colors.
• Aurora Count, Intensity, Speed, Ribbon Width, Waviness, and Softness define the ribbons themselves.

Bundled preset usage

Preset	API name	Availability	Variants
Luminous Sky	luminous-sky	FXMaster+	Normal

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.

34 exposed parameters1 Scene-only1 Region-onlyauroraborealis 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
Aurora Modei mode	select	side	Side View, Top Down, Horizon	Always
Aurora Palettei palette	select	northernLights	Lakeside Aurora Borealis, Northern Getaway, Northern Lights, Forest Northern Lights, Phenomenal Aurora, Aurora, Custom Colors	Always
Depth Colori color0	color	#01213a (enabled)	—	Always
Lower Curtain Colori color1	color	#01411f (enabled)	—	Always
Core Colori color2	color	#005d55 (enabled)	—	Always
Bright Edge Colori color3	color	#08afa8 (enabled)	—	Always
Glow Colori color4	color	#8aed07 (enabled)	—	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
Mixed Colorsi mixedColors	checkbox	Off	—	Always
Aurora Counti auroraCount	range	3	1–6 · step 1	Always
Intensityi intensity	range	0.7	0–1 · step 0.05	Always
Speedi speed	range	0.25	0–1 · step 0.01	Always
Ribbon Widthi ribbonWidth	range	0.4	0.1–1 · step 0.01	Always
Wavinessi waviness	range	0.55	0–1 · step 0.05	Always
Softnessi softness	range	0.55	0–1 · step 0.05	Always
Curtain Height Positioni sideVerticalPosition	range	0.36	0.05–0.95 · step 0.01	Shown when Aurora Mode = Side View
Curtain Falloffi sideCurtainHeight	range	0.36	0.08–0.85 · step 0.01	Shown when Aurora Mode = Side View
Path Anglei topDownAngle	range	30	0–360 · step 5	Shown when Aurora Mode = Top Down
Depth Glowi topDownDepth	range	0.55	0–1 · step 0.05	Shown when Aurora Mode = Top Down
Haze Strengthi topDownHazeStrength	range	0.5	0–1 · step 0.01	Shown when Aurora Mode = Top Down
Start Anchori horizonStartPosition	range	0.18	0–1 · step 0.01	Shown when Aurora Mode = Horizon
Exit Anchori horizonEndPosition	range	0.03	0–1 · step 0.01	Shown when Aurora Mode = Horizon
Overhead Dropi horizonDip	range	0.22	0.12–0.82 · step 0.01	Shown when Aurora Mode = Horizon
Path Slanti horizonAngle	range	-15	-45–45 · step 1	Shown when Aurora Mode = Horizon
Haze Strengthi horizonHazeStrength	range	0.63	0–1 · step 0.01	Shown when Aurora Mode = Horizon
Haze Heighti horizonHazeHeight	range	0.81	0.15–1 · step 0.01	Shown when Aurora Mode = Horizon
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_wikiauroraborealis_f",
    "type": "auroraborealis",
    "options": {
      "mode": "side",
      "palette": "aurora",
      "intensity": 0.65,
      "speed": 0.35,
      "auroraCount": 3
    }
  }],
});

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.