Skip to content

Sakura Bloom

Ambient reference
FXMaster+Particle effectAPI type: sakurabloom
Preview shows Sakura Bloom enabled for a Region

Sakura bloom particles with top-down and orbit modes, rotation, synchronized direction, and persistent background accumulation.

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 sakurabloom
Exposed parameters 36

Within an enabled Sakura Bloom effect, directional or Top Down petals and optional Background accumulation are configured separately. Disabling Sakura Bloom disables both layers. Choose Top Down before adjusting Rotation Strength, Direction, Scale, Speed, and Density.

Background adds persistent coverage with immediate or timed fill, opacity, coverage, variation, pile amount, pile size, and a separate Ground Particle Size.

Token Trails disturbs the accumulated petals. Trail Width, Trail Strength, and Trail Swirl define the path, Trail Lift Chance returns some petals to the airborne layer, and the settle controls determine how the surface returns.

  • Top Down: Switches Sakura Bloom to the overhead presentation intended for top-down maps. This changes particle projection and movement, so set it before finalizing scale and direction.
  • Rotation Strength: Controls how strongly sakura bloom particles rotate while moving. Higher values produce more visible turning and spin.
  • Direction: Sets the primary travel direction for sakura bloom particles. Directional Spread can add variation around this angle.
  • Background: Render a persistent field of settled particles behind the active effect. The field follows the same stack placement, scene or Region mask, Levels selection, and below-token/tile settings.
  • Token Trails: Allows moving tokens to disturb the persistent background and leave visible trails through it.
  • Top Down controls the airborne presentation, while Background and Token Trails control accumulated petals.
  • Tune Ground Particle Size separately from the airborne Scale.
Preset API name Availability Variants
Sakura Bloom sakura-bloom FXMaster+ Normal, Top Down

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.

36 exposed parameters1 Scene-onlysakurabloom API type

Hover 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.

ParameterControlDefaultRange or choicesAvailability
Below Tokens
belowTokens
checkboxOffAlways
Below Tiles
belowTiles
checkboxOffAlways
Below Foreground
belowForeground
checkboxOffAlways
Levels
levelsScene only
scene-levelsAll LevelsAlways
Tint
tint
color#FFFFFF (disabled)Always
Sound FX
soundFxEnabled
checkboxOffAlways
Sound FX Sounds
soundFxManualSoundIds
multi-selectRule default
Top Down
topDown
checkboxOff
Orbit
orbit
checkboxOff
Orbit Distance
orbitDistance
range0.50–1 · step 0.01
Rotation Strength
rotationStrength
range00–1 · step 0.01
Direction
direction
range0–360 · step 5
Synchronized Direction
synchronizedDirection
checkboxOff
Scale
scale
range0.150.1–1 · step 0.01Always
Speed
speed
range0.290.1–1 · step 0.01Always
Lifetime
lifetime
range0.270.1–1 · step 0.01Always
Density
density
range0.50.05–1 · step 0.05Always
Opacity
alpha
range10–1 · step 0.1Always
Background
backgroundEnabled
checkboxOffAlways
Background Fill
backgroundMode
selectaccumulateFull Coverage, Fill Over Time
Time to Full Coverage
backgroundDuration
range18010–3600 · step 10
Background Opacity
backgroundOpacity
range0.80–1 · step 0.01
Ground Coverage
backgroundCoverage
range0.60.05–1 · step 0.05
Fill Variation
backgroundFillVariation
range0.750–1 · step 0.05
Pile Amount
backgroundPileStrength
range0.450–1 · step 0.05
Pile Size (Grid Spaces)
backgroundPileSize
range40.5–12 · step 0.5
Ground Particle Size
backgroundParticleSize
range0.080.01–1 · step 0.01
Token Trails
backgroundInteractionEnabled
checkboxOn
Trail Width
backgroundInteractionRadius
range10–2 · step 0.05
Trail Strength
backgroundInteractionStrength
range0.50–1 · step 0.05
Trail Swirl
backgroundInteractionSwirl
range10–1 · step 0.05
Trail Lift Chance
backgroundInteractionLiftChance
range10–1 · step 0.05
Settle Time (Seconds)
backgroundInteractionSettleTime
range50.1–12 · step 0.1
Settle Impact
backgroundInteractionSettleImpact
range10–1 · step 0.05
Darkness Activation
darknessActivationEnabled
checkboxOffAlways
Darkness Activation Range
darknessActivationRange
range-dual{"min":0,"max":1}0–1 · step 0.01

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_wikisakurabloom_p",
"type": "sakurabloom",
"options": {
"belowTokens": false,
"tint": {
"value": "#FFFFFF",
"apply": false
},
"topDown": false,
"orbit": false,
"scale": 0.15
}
}],
});
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.