Skip to content

Ice

Environmental reference
FXMaster+Filter effectAPI type: ice
Preview shows Ice enabled

Frosted ice overlay with depth, veins, sheen, and highlight controls.

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 ice
Exposed parameters 24
  • Opacity: Controls the overall opacity of the ice treatment. Lower values preserve more of the original map.
  • Scale: Changes the size of the ice, frost, and vein pattern. Higher values create broader frozen features.
  • Frost Strength: Controls how much cloudy frost appears over the ice.
  • Water Strength: Controls how visible the moving water layer is beneath the ice.
  • Reflection Strength: Controls how strongly the scene is reflected in the ice.
  • Reflection Fresnel: Controls how strongly the reflection increases toward glancing viewing angles and surface edges.
  • Ice, Frost, Water, Sheen, and Reflection are separate visual layers and can be tuned one group at a time.
  • Reflection Distance, Reflection Blur, and Reflection Fresnel have a larger readability impact than tint alone.
Preset API name Availability Variants
Permafrost Surge permafrost-surge FXMaster+ Normal
Plague Miasma plague-miasma 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.

24 exposed parameters1 Scene-only1 Region-onlyice 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
iceTint
color#4dafff (enabled)Always
Opacity
strength
range10–1 · step 0.05Always
Scale
iceScale
range10.1–1 · step 0.01Always
Depth
depth
range0.30–1 · step 0.05Always
Frost Strength
frostStrength
range10–1 · step 0.05Always
Vein Strength
veinStrength
range0.30–1 · step 0.05Always
Water Tint
waterTint
color#000000 (enabled)Always
Water Strength
waterStrength
range10–1 · step 0.05Always
Water Speed
waterSpeed
range0.150–1 · step 0.01Always
Sheen Tint
sheenTint
color#d1d1d1 (enabled)Always
Sheen Strength
sheenStrength
range0.80–1 · step 0.05Always
Reflection Strength
reflectionStrength
range10–1 · step 0.05Always
Reflection Distance
reflectionDistance
range850–420 · step 5Always
Reflection Blur
reflectionBlur
range0.30–1 · step 0.05Always
Reflection Fresnel
reflectionFresnel
range10.1–1 · step 0.01Always
Sound FX
soundFxEnabled
checkboxOffAlways
Sound FX Sounds
soundFxManualSoundIds
multi-selectRule default
Darkness Activation
darknessActivationEnabled
checkboxOffAlways
Darkness Activation Range
darknessActivationRange
range-dual{"min":0,"max":1}0–1 · step 0.01
Edge Fade %
fadePercentRegion only
range00–1 · step 0.01Always

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_wikiice_f",
"type": "ice",
"options": {
"belowTokens": false,
"strength": 1
}
}],
});
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.