Fish

Animals reference

FXMaster+Particle effectAPI type: fish

Preview

Preview shows Fish and Underwater enabled together, Fish are limited to Betta Fish Type variants

Map maker

Map:Moonlight Maps

Animated koi, betta, manta ray, and spirit variants with orbit, directional movement, glow, trails, and token avoidance.

Animal effects add moving subjects to a Scene without creating tokens. Scale and Density control the population, while the available movement controls determine how they travel around the map. This effect also includes Token Avoidance controls for steering around eligible tokens.

Reference	Value
Package	FXMaster+
Effect kind	Particle effect
Category	Animals
Runtime type	fish
Exposed parameters	30

Important controls

• Fish Type: Selects which fish families are allowed to appear, such as koi, betta, manta rays, or spirit variants.
• Animations: Selects the animation variants that can be used for the chosen fish population.
• Directional Movement: Makes fish travel in the configured Direction instead of relying only on the effect’s default random movement.
• Token Avoidance: Makes fish steer away from eligible tokens instead of moving directly through them.
• Glow: Controls the direct glow added around each fish sprite.
• Trail: Controls the length and visibility of the motion trail behind moving fish.

Setup notes

• Fish Type and Animations define the visual population, while movement and Token Avoidance define how the school behaves.
• Token Avoidance works well when tokens should pass through or around the school without fish swimming directly through them.
• Glow, Bloom, and Trail can be used for bioluminescent, spirit, or other stylized fish variants.

Bundled preset usage

No bundled preset currently uses this effect directly. Add it through Particle 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.

30 exposed parameters1 Scene-onlyfish 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
Orbiti orbit	checkbox	Off	—	Always
Orbit Distancei orbitDistance	range	0.5	0–1 · step 0.01	Shown when Orbit = On
Glowi glow	range	0	0–1 · step 0.05	Always
Bloomi bloom	range	0	0–1 · step 0.05	Always
Traili trail	range	0	0–1 · step 0.05	Always
Lateral Movementi lateralMovement	range	0.35	0–1 · step 0.05	Hidden when Orbit = On
Fish Typei fishType	multi-select	All	Manta Ray, Manta Ray Spirit, Manta Ray Painted, Betta Rainbow, Betta Blue/Pink, Betta Purple, Betta Green, Betta Red, Betta Red/Yellow, Koi, Koi Spirit, Koi Painted	Always
Animationsi animations	multi-select	Mixed	Mixed, Swim, Glide	Always
Directional Movementi directionalMovement	checkbox	Off	—	Hidden when Orbit = On
Directioni direction	range	0	0–360 · step 5	Shown when Directional Movement = OnHidden when Orbit = On
Directional Spreadi spread	range	0	0–20 · step 1	Shown when Directional Movement = OnHidden when Orbit = On
Scalei scale	range	0.18	0.1–1 · step 0.01	Always
Speedi speed	range	0.27	0.1–1 · step 0.01	Always
Lifetimei lifetime	range	0.18	0.1–1 · step 0.01	Always
Densityi density	range	0.483	0.001–1 · step 0.001	Always
Opacityi alpha	range	1	0–1 · step 0.1	Always
Token Avoidancei tokenAvoidance	checkbox	Off	—	Always
Token Dispositionsi tokenAvoidanceDispositions	multi-select	Friendly, Neutral, Hostile, Secret	Friendly, Neutral, Hostile, Secret	Shown when Token Avoidance = On
Avoid Stationary Tokensi tokenAvoidanceAtRest	checkbox	Off	—	Shown when Token Avoidance = On
Avoidance Radiusi tokenAvoidanceRadius	range	1	0–3 · step 0.05	Shown when Token Avoidance = On
Avoidance Strengthi tokenAvoidanceStrength	range	0.65	0–1 · step 0.05	Shown when Token Avoidance = 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_wikifish_p",
    "type": "fish",
    "options": {
      "belowTokens": false,
      "tint": {
        "value": "#FFFFFF",
        "apply": false
      },
      "orbit": false,
      "directionalMovement": false,
      "direction": 0
    }
  }],
});

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.