Screen Shake

Visual reference

FXMasterFilter effectAPI type: screenshake

Preview

Preview shows Screen Shake with Timed mode disabled

Timed or continuous camera shake with strength, speed, smoothness, decay, edge protection, and audio-aware controls.

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	screenshake
Exposed parameters	21

Important controls

• Timed: When enabled, the scene effect turns itself off after Duration. Disable for a continuous shake, or enable Audio Aware for audio-triggered bursts.
• Strength: Maximum shake displacement. 0 = no movement; 1 = strongest shake.
• Shake Speed: Controls how quickly the shake changes direction. Higher values feel like rapid vibration; lower values feel like a heavier rolling impact.
• Smoothness: Smooths the shake path. Higher = softer camera drift; lower = harsher impact jitter.
• Decay: How strongly a timed shake fades toward zero over its duration.
• Edge Protection: Slightly overscans the composited image while shaking to reduce exposed edges.
• Audio Aware: Allows bass-heavy audio peaks to trigger Screen Shake. Use Audio Channels to choose what it listens to and Audio Bass Threshold to control sensitivity.

Setup notes

• Timed automatically ends the effect after the configured Duration.
• Edge Protection reduces exposed canvas edges during displacement; stronger shake generally needs more protection.
• Audio Aware can turn the filter into a reactive thunder, impact, or music-bass effect.

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.

21 exposed parameters1 Scene-only1 Region-onlyscreenshake 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
Timedi timed	checkbox	On	—	Hidden when Audio Aware = On
Strengthi strength	range	0.55	0–1 · step 0.01	Always
Bluri blur	range	0.12	0–1 · step 0.01	Always
Durationi duration	range	1.5	0.1–10 · step 0.1	Shown when Timed = On or Audio Aware = On
Shake Speedi speed	range	0.55	0–1 · step 0.01	Always
Smoothnessi smoothness	range	0.45	0–1 · step 0.01	Always
Decayi decay	range	0.8	0–1 · step 0.01	Shown when Timed = On or Audio Aware = On
Axisi axis	select	both	Both, Horizontal, Vertical	Always
Edge Protectioni edgeProtection	range	0.6	0–1 · step 0.01	Always
Audio Awarei audioAware	checkbox	Off	—	Always
Audio Channelsi audioChannels	multi-select	Environment	Music, Environment, Interface	Shown when Audio Aware = On
Audio Bass Thresholdi audioBassThreshold	range	0.75	0–1 · step 0.01	Shown when Audio Aware = On
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_wikiscreenshake_f",
    "type": "screenshake",
    "options": {
      "timed": true,
      "strength": 0.25,
      "duration": 1.2,
      "speed": 0.5,
      "smoothness": 0.5,
      "decay": 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.