Sunlight

Environmental reference

FXMaster+Filter effectAPI type: sunlight

Preview shows Sunlight with Parallel mode disabled

Directional sunlight rays with beam, color, edge fade, and intensity 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	`sunlight`
Exposed parameters	18

Important controls

Parallel Rays: Keeps the sunlight rays parallel instead of making them converge toward a single source point.
Ray Direction: Sets the direction the sunlight rays travel across the canvas.
Ray Intensity: Controls the brightness and visual strength of the sunlight rays.
Ray Volume: Controls how much ray detail and variation fills the beam area. Higher values create a fuller, more textured light volume.
Ray Length: Controls how far each sunlight ray extends across the canvas.
Opacity: Controls the overall opacity of the sunlight rays.
Above Darkness: Presents the luminous contribution from Sunlight above Foundry scene darkness. This option is available only on compatible luminous filters.

Setup notes

Ray Direction and Ray Length establish the beam geometry, while Ray Intensity, Opacity, and Tint establish visibility.
Parallel Rays works well for broad sunlight. Disabling it makes the rays converge toward a more localized source point.
Above Darkness presents the luminous ray contribution above Foundry scene darkness.

Bundled preset usage

Preset	API name	Availability	Variants
Twilight Sun	`twilight-sun`	FXMaster+	Normal
Black Sun	`black-sun`	FXMaster+	Normal
Divine Light	`divine-light`	FXMaster+	Normal
Monsoon	`monsoon`	FXMaster+	Normal
Sunshower	`sunshower`	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.

18 exposed parameters1 Scene-only1 Region-onlysunlight API type

Hover 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 Tokens `belowTokens`	checkbox	`Off`	—	Always
Below Tiles `belowTiles`	checkbox	`Off`	—	Always
Below Foreground `belowForeground`	checkbox	`Off`	—	Always
Levels `levels`Scene only	scene-levels	`All Levels`	—	Always
Parallel Rays `parallel`	checkbox	`On`	—	Always
Tint `color`	color	`#fff2a8 (disabled)`	—	Always
Sound FX `soundFxEnabled`	checkbox	`Off`	—	Always
Sound FX Sounds `soundFxManualSoundIds`	multi-select	`Rule default`	—
Ray Direction `angle`	range	`240`	0–360 · step 1	Always
Ray Intensity `gain`	range	`0.5`	0–1 · step 0.05	Always
Ray Volume `lacunarity`	range	`0.5`	0.1–1 · step 0.01	Always
Ray Length `beam_length`	range	`0`	0–8000 · step 10	Always
Opacity `alpha`	range	`0.75`	0–1 · step 0.05	Always
Speed `speed`	range	`0.1`	0–1 · step 0.01	Always
Above Darkness `aboveDarkness`	checkbox	`Off`	—	Always
Darkness Activation `darknessActivationEnabled`	checkbox	`Off`	—	Always
Darkness Activation Range `darknessActivationRange`	range-dual	`{"min":0,"max":1}`	0–1 · step 0.01
Edge Fade % `fadePercent`Region 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_wikisunlight_f",
    "type": "sunlight",
    "options": {
      "belowTokens": false,
      "color": {
        "value": "#fff2a8",
        "apply": false
      },
      "speed": 0.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.