Predator

Visual reference

FXMasterFilter effectAPI type: predator

Applies animated refractive noise with a chromatic edge treatment.

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	12

Important controls

• Noise Density: Controls the amount of animated refractive noise inside the Predator-style distortion.
• Speed: Changes how quickly the distortion pattern evolves and moves across the scene.
• Line Width: Changes the width of the bright refractive outline around distorted areas.

Setup notes

• Noise Density and Line Width define the refractive silhouette, while Speed controls the animation cadence.
• Use a Region to limit the filter to one part of the Scene, or a timed macro when it should appear only briefly.

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.

12 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
Noise Densityi noise	range	0.1	0–1 · step 0.1	Always
Speedi period	range	0.001	0–0.1 · step 0.001	Always
Line Widthi lineWidth	range	3	0.5–10 · step 0.5	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
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": {
      "belowTokens": false
    }
  }],
});

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.