Predator

Visual reference

FXMasterFilter effectAPI type: predator

Thermal color grading and token heat seeking with contrast, edge definition, scanlines, and sensor noise.

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	predator
Exposed parameters	18

Thermal image and token heat sources

With Token Heat Seek off, Thermal Strength blends a thermal palette over the Scene. Thermal Contrast, Edge Definition, Scanline Strength, Sensor Noise, Scanline Speed, and Scanline Width refine the image.

Enable Token Heat Seek to use visible tokens as heat sources against cooler surroundings. Token Disposition chooses which visible tokens contribute. The effect uses full thermal vision in this mode, so Thermal Strength is hidden.

This does not reveal hidden or occluded tokens. Effect masks, layer placement, and the current view still determine what can be seen.

Important controls

• Token Heat Seek: Uses visible tokens with selected dispositions as the heat sources in a full thermal image, while the surroundings remain cooler. Existing visibility masks and layer placement still apply.
• Token Disposition: Selects which visible token dispositions act as heat sources while Token Heat Seek is enabled. Tokens excluded by visibility or masking are not revealed through this setting.
• Thermal Strength: Blends the false-color thermal palette into the source image. 0 retains the original scene colors; 1 uses the full thermal treatment.
• Thermal Contrast: Separates cool and hot values in the thermal palette. Higher values create stronger temperature differences across the scene.
• Edge Definition: Highlights local temperature boundaries so creatures, objects, and terrain produce sharper thermal silhouettes.
• Scanline Strength: Controls the brightness variation of the moving scanline pattern. Set it to 0 to hide the scanlines while keeping the other Predator systems active.
• Scanline Speed: Controls how quickly the scanline pattern travels across the scene. 0 stops the scanline movement.

Setup notes

• Thermal Strength blends the false-color palette into the original scene, while Thermal Contrast separates cool and hot values.
• Edge Definition sharpens temperature boundaries. Scanline Strength, Sensor Noise, Scanline Speed, and Scanline Width shape the sensor presentation independently.

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.

18 exposed parameters1 Scene-only1 Region-onlypredator 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
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
Token Heat Seeki tokenHeatSeek	checkbox	Off	—	Always
Token Dispositioni tokenHeatSeekDispositions	multi-select	Friendly, Neutral, Hostile, Secret	Friendly, Neutral, Hostile, Secret	Shown when Token Heat Seek = On
Thermal Strengthi thermalStrength	range	0	0–1 · step 0.05	Hidden when Token Heat Seek = On
Thermal Contrasti thermalContrast	range	0	0–1 · step 0.05	Always
Edge Definitioni edgeDefinition	range	0	0–1 · step 0.05	Always
Scanline Strengthi scanlineStrength	range	1	0–1 · step 0.05	Always
Sensor Noisei noise	range	0	0–1 · step 0.1	Always
Scanline Speedi speed	range	0.3	0–1 · step 0.01	Always
Scanline Widthi lineWidth	range	0.5	0–1 · step 0.01	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_wikipredator_f",
    "type": "predator",
    "options": {
      "thermalStrength": 0.8,
      "thermalContrast": 0.6,
      "edgeDefinition": 0.35,
      "scanlineStrength": 0.8,
      "noise": 0.15,
      "speed": 0.3,
      "lineWidth": 0.5
    }
  }],
});

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.