Underwater

Environmental reference

FXMasterFilter effectAPI type: underwater

Preview

Preview shows Underwater and Fish enabled together

Map maker

Map:Moonlight Maps

Animated underwater distortion for submerged scenes or other liquid-like visual treatments.

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	underwater
Exposed parameters	11

Important controls

• Scale: Changes the size of the moving underwater distortion pattern. Higher values create broader ripples across the scene.
• Speed: Changes how quickly the underwater distortion moves.

Setup notes

• Speed controls movement while Scale controls the size of the distortion pattern.
• Underwater can pair with Bubbles, Fish, or Water, but several strong distortion filters in the same area can make the map difficult to read.

Bundled preset usage

Preset	API name	Availability	Variants
Aether Haze	aether-haze	FXMaster+	Normal

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.

11 exposed parameters1 Scene-only1 Region-onlyunderwater 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
Speedi speed	range	0.15	0–1 · step 0.01	Always
Scalei scale	range	0.19	0–1 · step 0.01	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_wikiunderwater_f",
    "type": "underwater",
    "options": {
      "belowTokens": false,
      "speed": 0.15,
      "scale": 0.19
    }
  }],
});

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.