Bubbles

Ambient reference

FXMasterParticle effectAPI type: bubbles

Preview

Preview shows Bubbles being played with Token Trails enabled

Rising or top-down bubbles with orbiting, synchronized direction, and token trail interactions.

Ambient effects add visible movement without replacing the full weather setup. Use them on their own or layer them with another particle or filter.

Reference	Value
Package	FXMaster
Effect kind	Particle effect
Category	Ambient
Runtime type	bubbles
Exposed parameters	24

Important controls

• Top Down: Switches Bubbles to the overhead presentation intended for top-down maps. This changes particle projection and movement, so set it before finalizing scale and direction.
• Directional Movement: Makes bubbles travel in the configured Direction instead of relying only on the effect’s default random movement.
• Synchronized Direction: Uses the active Wind or Duststorm direction for Bubbles. When the source direction changes, this effect follows it.
• Token Trails: Pop bubbles that moving tokens pass through.
• Trail Width: Sets the bubble pop path width as a multiplier of the moving token’s footprint.

Setup notes

• Top Down is intended for overhead maps and can pair well with Underwater or Water.
• Token Trails create temporary openings through the bubbles. Tune Trail Width before increasing Trail Strength.

Bundled preset usage

Preset	API name	Availability	Variants
Nullfront	nullfront	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.

24 exposed parameters1 Scene-onlybubbles 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
Tinti tint	color	#FFFFFF (disabled)	—	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
Top Downi topDown	checkbox	Off	—	Hidden when Orbit = On
Orbiti orbit	checkbox	Off	—	Hidden when Top Down = On
Orbit Distancei orbitDistance	range	0.5	0–1 · step 0.01	Shown when Orbit = On
Directional Movementi directionalMovement	checkbox	Off	—	Hidden when Orbit = On or Top Down = On
Directioni direction	range	—	0–360 · step 5	Shown when Directional Movement = OnHidden when Orbit = On or Top Down = On
Synchronized Directioni synchronizedDirection	checkbox	Off	—	Shown when Directional Movement = OnHidden when Orbit = On or Top Down = On
Directional Spreadi spread	range	0	0–20 · step 1	Shown when Directional Movement = OnHidden when Orbit = On or Top Down = On
Scalei scale	range	0.27	0.1–1 · step 0.01	Always
Speedi speed	range	0.27	0.1–1 · step 0.01	Always
Lifetimei lifetime	range	0.27	0.1–1 · step 0.01	Always
Densityi density	range	0.29	0.01–1 · step 0.01	Always
Opacityi alpha	range	1	0–1 · step 0.1	Always
Token Trailsi tokenTrailsEnabled	checkbox	On	—	Always
Trail Widthi tokenTrailWidth	range	1	0–2 · step 0.05	Shown when Token Trails = On
Trail Strengthi tokenTrailStrength	range	0.85	0–1 · step 0.01	Shown when Token Trails = 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

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({
  particles: [{
    "id": "apiMacro_wikibubbles_p",
    "type": "bubbles",
    "options": {
      "belowTokens": false,
      "tint": {
        "value": "#FFFFFF",
        "apply": false
      },
      "topDown": false,
      "orbit": false,
      "directionalMovement": false
    }
  }],
});

await FXMASTER.api.effects.particles.stop(created.particles);

For complete API behavior, scene targeting, stack ordering, and toggle groups, see the Direct Effect API guide.