Neon

Visual reference

FXMaster+Filter effectAPI type: neon

Preview

Preview shows Neon in Fill + Outline mode using custom source color matching

Selective neon fill, outlines, halo, source-color matching, pulse, slide, flicker, and above-darkness presentation.

Visual filters change the rendered Scene. Check map, token, and text visibility after changing their strength or opacity.

Reference	Value
Package	FXMaster+
Effect kind	Filter effect
Category	Visual
Runtime type	neon
Exposed parameters	48

Source color matching

Neon applies its Fill, Outline, and Halo only to source artwork that passes the selected matching rules. Source Color Matching can use broad Color Families, up to five Custom Source Colors, or both.

When Color Families are enabled, Detection Mode, Affected Source Colors, Threshold, and Smoothness define the match. When Custom Colors are enabled, use Custom Color Range for hue tolerance and Custom Shade Range for lighter or darker versions of each selected color.

Neon style and color

Neon Style selects Fill, Outline, or Fill + Outline. Core Color controls Fill and Outline, while Halo Color controls the surrounding glow. Disable Apply on either color to retain or derive color from the matched source artwork.

Outline modes expose Outline Definition, Outline Width, Outline Strength, and Outline Position. Intensity, Halo Strength, Halo Radius, and Saturation affect the complete result.

Animation

Pulse alternates between on and off states. Slide sweeps an active band across the effect area. Pulse and Slide are mutually exclusive, while Flicker can be combined with either one.

Above Darkness presents Neon’s luminous contribution above Foundry scene darkness without changing its order relative to the other FXMaster rows.

Important controls

• Source Color Matching: Chooses whether Neon matches Color Families, Custom Colors, or both.
• Affected Source Colors: Selects which source color families are eligible for Neon. All includes every available family.
• Neon Style: Selects Fill, Outline, or Fill + Outline for the matched parts of the scene.
• Intensity: Controls the overall Neon strength. Higher values increase the visible Fill and Outline contribution.
• Halo Strength: Controls Halo brightness. 0 disables the halo; higher values make it more prominent around matched areas.
• Outline Width: Controls the rendered width of the Outline around matched areas.
• Pulse: Cycles Neon between on and off states. Pulse and Slide are mutually exclusive.
• Slide: Sweeps an active Neon band across the effect area. Slide and Pulse are mutually exclusive.
• Flicker: Adds irregular brightness variation to Fill, Outline, and Halo. Flicker can be used with either Pulse or Slide.
• Above Darkness: Presents the luminous contribution from Neon above Foundry scene darkness. This option is available only on compatible luminous filters.

Setup notes

• Choose Source Color Matching before tuning Threshold, Smoothness, or the custom color ranges so the filter is matching the intended artwork.
• Pulse and Slide are mutually exclusive. Flicker can be combined with either animation mode.
• Halo Radius can be visually expensive at higher values, especially when Neon covers a large portion of the Scene.

Bundled preset usage

No bundled preset currently uses this effect directly. Add it through Filter Effects or the Direct Effect API.

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.

48 exposed parameters1 Scene-only1 Region-onlyneon 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
Core Colori color	color	#00eaff (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
Halo Colori haloColor	color	#7dffff (enabled)	—	Always
Neon Stylei mode	select	fill	Fill, Outline, Fill + Outline	Always
Source Color Matchingi sourceColorMode	select	families	Color Families, Custom Colors, Families + Custom Colors	Always
Detection Modei detectionMode	select	combined	Brightness, Saturation, Combined	Shown when Source Color Matching = Color Families or Source Color Matching = Families + Custom Colors
Affected Source Colorsi colorFamilies	multi-select	All	All, Red, Orange, Yellow, Lime / Yellow-Green, Green, Teal, Cyan, Blue, Indigo, Purple, Magenta, Pink, Brown, Tan / Beige, White / Gray	Shown when Source Color Matching = Color Families or Source Color Matching = Families + Custom Colors
Thresholdi threshold	range	0.42	0–1 · step 0.01	Shown when Source Color Matching = Color Families or Source Color Matching = Families + Custom Colors
Smoothnessi smoothness	range	0.36	0–1 · step 0.01	Shown when Source Color Matching = Color Families or Source Color Matching = Families + Custom Colors
Custom Source Color 1i customSourceColor1	color	#ffffff (enabled)	—	Shown when Source Color Matching = Custom Colors or Source Color Matching = Families + Custom Colors
Custom Source Color 2i customSourceColor2	color	#ff0000 (disabled)	—	Shown when Source Color Matching = Custom Colors or Source Color Matching = Families + Custom Colors
Custom Source Color 3i customSourceColor3	color	#00ff00 (disabled)	—	Shown when Source Color Matching = Custom Colors or Source Color Matching = Families + Custom Colors
Custom Source Color 4i customSourceColor4	color	#0000ff (disabled)	—	Shown when Source Color Matching = Custom Colors or Source Color Matching = Families + Custom Colors
Custom Source Color 5i customSourceColor5	color	#ffff00 (disabled)	—	Shown when Source Color Matching = Custom Colors or Source Color Matching = Families + Custom Colors
Custom Color Rangei customColorRange	range	0.15	0–1 · step 0.01	Shown when Source Color Matching = Custom Colors or Source Color Matching = Families + Custom Colors
Custom Shade Rangei customShadeRange	range	0.25	0–1 · step 0.01	Shown when Source Color Matching = Custom Colors or Source Color Matching = Families + Custom Colors
Intensityi intensity	range	0.43	0–1 · step 0.01	Always
Halo Strengthi glow	range	0.45	0–1 · step 0.01	Always
Halo Radiusi glowRadius	range	5	0–12 · step 0.5	Always
Outline Definitioni edgeDefinition	range	0.25	0–1 · step 0.05	Shown when Neon Style = Outline or Neon Style = Fill + Outline
Outline Widthi outlineWidth	range	2	0.5–8 · step 0.5	Shown when Neon Style = Outline or Neon Style = Fill + Outline
Outline Strengthi outlineStrength	range	0.5	0–1 · step 0.01	Shown when Neon Style = Outline or Neon Style = Fill + Outline
Outline Positioni outlinePosition	select	outside	Outside, Centered, Inside	Shown when Neon Style = Outline or Neon Style = Fill + Outline
Saturationi saturation	range	1.35	0–2.5 · step 0.05	Always
Pulsei pulseEnabled	checkbox	Off	—	Hidden when Slide = On
Pulse Speedi pulseSpeed	range	0.27	0.1–1 · step 0.01	Shown when Pulse = On
Pulse On Duration (Seconds)i pulseOnDuration	range	0.75	0.05–10 · step 0.05	Shown when Pulse = On
Pulse Off Duration (Seconds)i pulseOffDuration	range	0.75	0.05–10 · step 0.05	Shown when Pulse = On
Pulse Fade Duration (Seconds)i pulseFadeDuration	range	0.15	0–2 · step 0.05	Shown when Pulse = On
Slidei slideEnabled	checkbox	Off	—	Hidden when Pulse = On
Slide Directioni slideDirection	range	0	0–360 · step 5	Shown when Slide = On
Slide Speedi slideSpeed	range	0.27	0.1–1 · step 0.01	Shown when Slide = On
Slide Travel Duration (Seconds)i slideDuration	range	3	0.25–20 · step 0.25	Shown when Slide = On
Slide Pause Duration (Seconds)i slidePauseDuration	range	0.5	0–10 · step 0.25	Shown when Slide = On
Slide Widthi slideWidth	range	0.3	0.05–1 · step 0.05	Shown when Slide = On
Slide Softnessi slideSoftness	range	0.25	0–1 · step 0.05	Shown when Slide = On
Flickeri flickerEnabled	checkbox	Off	—	Always
Flicker Speedi flickerSpeed	range	0.27	0.1–1 · step 0.01	Shown when Flicker = On
Flicker Amounti flickerAmount	range	0.35	0–1 · step 0.05	Shown when Flicker = 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_wikineon_f",
    "type": "neon",
    "options": {
      "mode": "fillOutline",
      "sourceColorMode": "families",
      "colorFamilies": [
        "cyan",
        "magenta",
        "purple"
      ],
      "threshold": 0.42,
      "intensity": 0.5,
      "glow": 0.45
    }
  }],
});

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.