Skip to content

Stars

Ambient reference
FXMasterParticle effectAPI type: stars

Slow ambient star particles for astral scenes, dreamlike spaces, or void backgrounds.

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 stars
Exposed parameters 16
  • Orbit: Makes stars circulate around the effect area instead of only crossing the canvas in a straight or drifting path.
  • Scale: Changes the rendered size of stars. It does not change how many particles are present.
  • Speed: Changes how quickly stars move and animate across the canvas. It does not change particle size or count.
  • Density: Changes how many stars are visible or spawned at once. It does not change their size.
  • Opacity: Controls the transparency of stars. Lower values allow more of the map to show through.
  • Lower Density works well when Stars are used as a subtle accent. Raise it when the stars should become a stronger background layer.
  • Tint, Opacity, and Scale usually change the overall mood more than Density alone.
Preset API name Availability Variants
Divine Light divine-light FXMaster+ Normal
Nullfront nullfront FXMaster Normal

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.

16 exposed parameters1 Scene-onlystars 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#bee8ee (disabled)Always
Sound FX
soundFxEnabled
checkboxOffAlways
Sound FX Sounds
soundFxManualSoundIds
multi-selectRule default
Orbit
orbit
checkboxOffAlways
Orbit Distance
orbitDistance
range0.50–1 · step 0.01
Scale
scale
range0.270.1–1 · step 0.01Always
Speed
speed
range0.270.1–1 · step 0.01Always
Lifetime
lifetime
range0.270.1–1 · step 0.01Always
Density
density
range0.30.05–1 · step 0.05Always
Opacity
alpha
range10–1 · step 0.1Always
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_wikistars_p",
"type": "stars",
"options": {
"belowTokens": false,
"tint": {
"value": "#bee8ee",
"apply": false
},
"orbit": false,
"scale": 0.27,
"speed": 0.27
}
}],
});
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.