Fireworks Engine Options Reference

One place to look up the current public option paths, what they affect, and which ones are persistent vs one-shot.

Единое место для поиска текущих публичных путей опций, на что они влияют и какие из них являются постоянными, а какие одноразовыми.

How to read this file Как читать этот документ

Scope map Карта областей видимости (Scope map)

Scope Examples NotesПримечания
Persistent engine config canvas, runtime, performance, rocket, rocketTailEmbers, burstForms, burstSparks, burstCenterFlash, burstTwinkleCloud Stored on the engine and used as the baseline for later launches. Сохраняется в движке и используется как базовая линия для последующих запусков.
Start-time config mode, bursts, duration, rocketCount, rocketDelay, totalDuration, timeScale, sizeScale, simple, hooks Used by start(config) and startPreset(name) for a single run. Используется в start(config) и startPreset(name) для одиночного запуска.
Launch-time config timeScale, sizeScale, simple, rocket extras, rocketTailEmbers, burst*, count Used by one launch call such as burst(...), confetti(...), or launchRocket(...). Используется для одного вызова запуска, такого как burst(...), confetti(...), или launchRocket(...).

Start-time controls

These are start-time controls. They are read by start(config) / startPreset(name); if you pass them to createFireworksEngine(), they are not stored as persistent engine defaults.

Это элементы управления во время старта. Они считываются через start(config) / startPreset(name); если вы передадите их в createFireworksEngine(), они не будут сохранены как постоянные значения по умолчанию.

Path Default Used by What it doesЧто делает
mode 'burst' start, preset Selects the start behavior. 'burst' launches multiple bursts directly. 'rocket' schedules rockets and lets them resolve into bursts. Выбирает поведение запуска. 'burst' запускает взрывы напрямую. 'rocket' планирует ракеты, которые затем переходят во взрывы.
bursts 4 start (mode: 'burst') Number of bursts scheduled across the start duration. Количество взрывов, запланированных на время запуска.
duration 1200 ms start (mode: 'burst') Duration span for 'burst' mode. Продолжительность для режима 'burst'.
rocketCount 2 start (mode: 'rocket') Number of rockets scheduled. Количество запланированных ракет.
rocketDelay 220 ms start (mode: 'rocket') Delay between scheduled rockets. Задержка между запланированными ракетами.
totalDuration 2200 ms start (mode: 'rocket') Finish timeout for rocket-mode starts. Таймаут завершения для стартов в режиме ракеты.
timeScale 1 start / launch / update Scales the whole timeline. Higher values run faster, lower values slower. Launch helpers apply this through updateOptions, so the new value stays on the engine until another timeScale is provided. Масштабирует весь таймлайн. Высокие значения = быстрее, низкие = медленнее. Launch-хелперы применяют это через updateOptions, поэтому новое значение остается в engine, пока не будет передан другой timeScale.
sizeScale 1 start / launch / update Experimental envelope scaling. Changes more than visible size; keep close to 1 for original look. It becomes persistent when set through createFireworksEngine or updateOptions; launch/start configs use their own normalized value for that run. Масштабирование эффекта. Меняет не только размер, держите ближе к 1 для оригинального вида. Значение становится постоянным, если задано через createFireworksEngine или updateOptions; launch/start configs используют свое нормализованное значение для конкретного запуска.
simple false start / launch Simplified burst-path hint used by some authored recipes. Упрощенный путь взрыва (для производительности).
onStart none start / preset Lifecycle hook fired when a run starts. Lifecycle хук: вызывается при старте.
onStop none start / preset Lifecycle hook fired when a run stops. Lifecycle хук: вызывается при остановке.
onFinish none start / preset Lifecycle hook fired when the run drains naturally. Lifecycle хук: вызывается, когда все частицы гаснут.

Canvas (Монтаж и DOM)

Path Default What it doesЧто делает
canvas.appendTarget omitted If present, the engine appends its canvas here. If omitted, creates a full-viewport canvas. Если указано, движок создает Canvas внутри этого элемента. Иначе — на весь Viewport.
canvas.maxDevicePixelRatio 2 Caps the canvas DPR so rendering does not scale without limit on dense screens. Ограничивает DPR, чтобы рендер не тормозил на очень плотных экранах.
canvas.zIndex 9999 Controls the canvas stacking order. Управляет порядком наложения Canvas.

Runtime (Интеграция хоста)

These options are integration hooks, not visual tuning knobs.

Эти опции являются хуками интеграции, а не визуальными настройками.

Path Default behavior What it doesЧто делает
runtime.document global document Overrides the document used for DOM access. Переопределяет document для доступа к DOM.
runtime.window global window Overrides the window used for viewport and events. Переопределяет window для viewport и событий.
runtime.root body fallback Root element or resolver function: ({ document, window }) => element. Корневой элемент. Может быть функцией: ({ document, window }) => element.
runtime.prefersReducedMotion built-in check Lets the host provide a custom reduced-motion detector. Кастомный детектор отключения анимаций (Accessibility).
runtime.requestAnimationFrame global rAF Custom animation frame scheduler. Кастомный планировщик кадров.
runtime.cancelAnimationFrame global cAF Custom animation frame canceller. Кастомный отменщик кадров.
runtime.setTimeout global setTimeout Custom timeout scheduler. Кастомный планировщик таймаутов.
runtime.clearTimeout global clearTimeout Custom timeout canceller. Кастомный отменщик таймаутов.
runtime.now performance.now() Custom time source for the render loop. Кастомный источник времени для цикла рендера.

Performance (Производительность)

Path Default What it doesЧто делает
performance.enableBurstQueueThrottling false Enables burst queue throttling under pressure. Changes behavior under load. Включает троттлинг очереди взрывов под нагрузкой. Изменяет поведение системы при давлении.
performance.maxBurstParticlesPerFrame 12 Caps burst particles emitted per frame when pressure logic is active. Ограничивает кол-во излучаемых частиц за кадр, если включено давление.
performance.particlePressureThreshold 18 Threshold used to decide when pressure-aware render behavior should kick in. Порог частиц, при котором включается поведение рендера под давлением (упрощение).
performance.fastRectRadiusThreshold 1.45 Radius threshold used by the fast rectangle rendering path. Порог радиуса для быстрого пути рендера через прямоугольники.

Rocket (Ракета)

These fields are part of the persistent rocket config stored on the engine.

Эти поля являются частью постоянной конфигурации ракеты, хранящейся в движке.

Path Default What it doesЧто делает
rocket.enabled true Enables rocket flight. false for direct burst with no trail. Включает полет ракеты. false для прямого взрыва без следа.
rocket.colorMode 'palette' Color source: 'palette', 'rgb', 'single'. Источник цвета: 'palette', 'rgb', 'single'.
rocket.singleColor '#ffd166' Rocket color used when colorMode is 'single'. Цвет ракеты при colorMode: 'single'.
rocket.color alias singleColor Alternate input name. Альтернативное имя ввода.
rocket.palette null Rocket palette. If omitted, falls back to the current burst palette. Палитра ракеты. Если нет, используется текущая палитра burst.
rocket.streakLength 5 Visible rocket streak length. Видимая длина шлейфа ракеты.
rocket.finalStreakLength 48 Final streak length at the end of the rocket path. Финальная длина шлейфа в конце пути.
rocket.thickness 1.35 Rocket streak thickness. Толщина шлейфа ракеты.
rocket.speed 0 Flight speed (px/s). If > 0, takes priority over duration. Скорость полета (px/s). Если > 0, имеет приоритет над duration.

Rocket Launch Extras (Экстра параметры при запуске)

These fields are accepted when launching rockets, but they are not stored as persistent engine defaults.

Принимаются при запуске ракет, но не сохраняются в движке.

Path Default What it doesЧто делает
rocket.durationMin 0.7 s Lower bound for duration when speed is 0. Нижняя граница времени полета (если speed = 0).
rocket.durationMax 1.0 s Upper bound for duration when speed is 0. Верхняя граница времени полета (если speed = 0).
rocket.cascade see belowсм. ниже Nested cascade behavior for rocket launches. Вложенное поведение каскада.

Rocket Cascade (rocket.cascade.*)

Path Default What it doesЧто делает
rocket.cascade.mode 'burst' Payload type: 'burst' (follow-ups) or 'rocket' (child rockets). Тип каскада: 'burst' (серия взрывов) или 'rocket' (дочерние ракеты).
rocket.cascade.bursts 0 Number of follow-up bursts or child rockets. Кол-во последующих взрывов или дочерних ракет.
rocket.cascade.childBursts 0 Number of follow-up cascade bursts each child rocket emits after its own main target burst. Количество последующих каскадных взрывов, которые дочерняя ракета дает после своего основного взрыва в цели.
rocket.cascade.childSpeedMin omitted Lower bound for child rocket speed. Мин. скорость дочерней ракеты.
rocket.cascade.childSpeedMax omitted Upper bound for child rocket speed. Макс. скорость дочерней ракеты.
rocket.cascade.childDurationMin omitted Lower bound for child rocket duration. Мин. время жизни дочерней ракеты (если speed не задан).
rocket.cascade.childDurationMax omitted Upper bound for child rocket duration. Макс. время жизни дочерней ракеты.
rocket.cascade.childDirectionDeg 0 Direction for child rocket fan-out. Направление разлета дочерних ракет.
rocket.cascade.childConeDeg 360 Spread width for child rocket fan-out. Ширина сектора разлета дочерних ракет.
rocket.cascade.delay 48 ms Delay between follow-up cascade launches. Задержка между запусками каскада.
rocket.cascade.spreadX 18 Horizontal spread for cascade targets. Горизонтальный разброс целей каскада.
rocket.cascade.spreadY 18 Vertical spread for cascade targets. Вертикальный разброс целей каскада.
rocket.cascade.burst inherits Burst overrides for burst-mode cascades. Переопределения взрыва для burst-каскадов.
rocket.cascade.child derived Child rocket overrides when mode is 'rocket'. Переопределения для дочерних ракет (при mode: 'rocket').

Rocket Tail Embers (Дымный след)

The white ember plume behind the rocket. Tune brightness, fade, and spread; there is no separate color palette.

Белый шлейф искр за ракетой. Цвет не настраивается (только яркость, затухание и разброс).

Path Default What it doesЧто делает
rocketTailEmbers.enabled true Enables the ember plume behind the rocket.Включает шлейф (plume) за ракетой.
rocketTailEmbers.count 6 Number of embers spawned.Количество генерируемых искр.
rocketTailEmbers.brightness 2 Ember brightness multiplier.Множитель яркости.
rocketTailEmbers.fade 1 Ember fade rate.Скорость затухания.
rocketTailEmbers.spreadX 1.5 Horizontal spread of the plume.Горизонтальный разброс искр.
rocketTailEmbers.spreadY 40 Vertical spread of the plume.Вертикальный разброс искр.
rocketTailEmbers.speed 2 Ember speed.Скорость искр шлейфа.
rocketTailEmbers.size 0.6 Ember size.Размер искр шлейфа.

Burst Forms (Частицы-формы / Конфетти)

Path Default What it doesЧто делает
burstForms.enabled true Enables form particles.Включает частицы-формы.
burstForms.palette DEFAULT Shared burst palette (fallback for other layers).Общая burst палитра. Служит фоллбэком для других слоев.
burstForms.count 27 Number of form particles.Кол-во частиц-форм.
burstForms.speedMin 100 Lower speed bound.Мин. скорость разлета.
burstForms.speedMax 250 Upper speed bound.Макс. скорость разлета.
burstForms.directionDeg 90 Center direction for the burst sector.Центральное направление сектора разлета.
burstForms.coneDeg 360 Full width of the burst sector.Ширина сектора разлета (360 = круг).
burstForms.gravity 90 Gravity for form particles.Гравитация, действующая на формы.
burstForms.lifeMin 0.6 s Lower life bound.Мин. время жизни форм.
burstForms.lifeMax 1.5 s Upper life bound.Макс. время жизни форм.
burstForms.sizeMin 1.5 Lower size bound.Мин. размер.
burstForms.sizeMax 2.5 Upper size bound.Макс. размер.
burstForms.spin 0 Maximum spin amount for confetti-style rotation.Максимальная сила вращения в стиле конфетти (флаттер).
burstForms.spinCoverage 1 Approximate fraction of each particle's lifetime that can spend rotating, with random start and stop windows (0 - 1).Примерная доля жизни каждой частицы, которую она может провести во вращении, со случайными окнами старта и остановки (0 - 1).
burstForms.spinDuration 2 s Average active spin window length. Higher values allow longer continuous rotations.Средняя длина активного окна вращения. Высокие значения дают более длинные непрерывные серии вращения.
burstForms.spinPause 2 s Average pause between active spin windows.Средняя пауза между активными окнами вращения.
burstForms.highlight 0 Specular-style highlight strength for spinning form particles. It mixes the particle color toward white at the highlight phase.Сила блика для вращающихся form-частиц. В фазе блика цвет частицы смешивается с белым.
burstForms.highlightAngleDeg 0 deg Spin phase angle where the main highlight appears.Фазовый угол вращения, при котором появляется основной блик.
burstForms.highlightWidth 0.18 Highlight window width from sharp to soft (0 - 1).Ширина окна блика: от резкого к мягкому (0 - 1).
burstForms.wobble 0 Side-to-side drift amount.Раскачивание (дрифт) из стороны в сторону.
burstForms.shape 'circle' Shape: 'circle', 'square', 'rectangle', 'glyph', 'mix', or combined.Форма: 'circle', 'square', 'rectangle', 'glyph', 'mix' или их комбинации.
burstForms.glyph '★' Glyph string used when shape is 'glyph' or 'mix'.Строка символов при shape: 'glyph' или 'mix'.
burstForms.colorMode 'palette' Color mode: 'palette', 'rgb', 'single'.Цветовой режим: 'palette', 'rgb', 'single'.
burstForms.singleColor '#ffd166' Color used when mode is 'single'.Цвет при colorMode: 'single'.

Burst Sparks (Искры взрыва)

Path Default What it doesЧто делает
burstSparks.enabled true Enables spark particles.Включает частицы-искры.
burstSparks.palette null Spark palette. Falls back to burstForms palette.Палитра. Если опущена, берется из burstForms.
burstSparks.count 80 Number of spark particles.Кол-во частиц-искр.
burstSparks.length 27 Base spark trail length.Базовая длина шлейфа искры.
burstSparks.tailScale 1.5 Spark trail-length override (independent from sizeScale).Переопределение длины шлейфа (не зависит от sizeScale).
burstSparks.thickness 1.3 Spark trail thickness.Толщина шлейфа искры.
burstSparks.speedMin 0 Lower speed bound.Мин. скорость разлета.
burstSparks.speedMax 320 Upper speed bound.Макс. скорость разлета.
burstSparks.directionDeg 90 Center direction for the spark sector.Центральное направление сектора разлета.
burstSparks.coneDeg 360 Full width of the spark sector.Ширина сектора разлета (360 = круг).
burstSparks.gravity 50 Gravity for sparks.Гравитация.
burstSparks.lifeMin 0.5 s Lower life bound.Мин. время жизни.
burstSparks.lifeMax 1.6 s Upper life bound.Макс. время жизни.
burstSparks.shape 'fade' Spark shape: 'uniform', 'spindle', 'fade'.Форма искры: 'uniform', 'spindle', 'fade'.
burstSparks.colorMode 'palette' Color mode: 'palette', 'rgb', 'single'.Цветовой режим: 'palette', 'rgb', 'single'.
burstSparks.singleColor '#ffd166' Color used when mode is 'single'.Цвет при colorMode: 'single'.

Burst Center Flash (Центральная вспышка)

Path Default What it doesЧто делает
burstCenterFlash.enabled true Enables the center flash.Включает центральную вспышку.
burstCenterFlash.startSize 35 Starting flash size.Начальный размер вспышки.
burstCenterFlash.endSize 85 Ending flash size.Конечный размер вспышки.
burstCenterFlash.peakAlpha 0.3 Peak alpha of the flash.Пиковая прозрачность (alpha).
burstCenterFlash.attack 0.1 Flash attack time.Время разгорания вспышки.
burstCenterFlash.fade 0.1 Flash fade time.Время затухания вспышки.
burstCenterFlash.colorMode 'rgb' Flash color mode: 'palette', 'rgb', 'single'.Цветовой режим: 'palette', 'rgb', 'single'.
burstCenterFlash.color '#00ffee' Flash color used in 'single'-color mode or as fallback.Цвет вспышки (при 'single' или как fallback).
burstCenterFlash.innerStop 0.3 Inner gradient stop for the flash.Внутренний стоп градиента вспышки.

Burst Twinkle Cloud (Мерцающее облако)

These particles are white. Tune brightness, size, duration, and spread instead of color.

Эти частицы всегда белые. Настраивается яркость, размер, длительность и разброс.

Path Default What it doesЧто делает
burstTwinkleCloud.enabled true Enables the twinkle cloud.Включает мерцающее облако.
burstTwinkleCloud.count 240 Number of twinkles.Кол-во мерцающих частиц (twinkles).
burstTwinkleCloud.radius 110 Cloud radius.Радиус облака.
burstTwinkleCloud.startDelay 0.4 s Delay before twinkles begin.Задержка перед появлением.
burstTwinkleCloud.duration 0.5 s Cloud duration.Общая длительность облака.
burstTwinkleCloud.twinkleLife 0.2 s Life of an individual twinkle.Время жизни отдельной блестки.
burstTwinkleCloud.brightness 2 Twinkle brightness multiplier.Множитель яркости блесток.
burstTwinkleCloud.size 1.2 Twinkle size.Размер блестки.
burstTwinkleCloud.spawnSpread 1 Spawn spread for the cloud.Степень разброса частиц в облаке.

Helper Shortcuts (Методы-сокращения)

Helper What it doesЧто делает
boom(x, y, options?) Alias of launchRocketAt(x, y, options?).Алиас для launchRocketAt(x, y, options?).
burst(x, y, options?) Direct burst at a target point without rocket flight.Прямой взрыв в точке (без полета ракеты).
confetti(x, y, options?) Recipe helper with rocket disabled and confetti defaults.Конфетти (с отключенной ракетой и предустановками для бумажных частиц).
launchPresetAt(name, x, y, options?) Resolves a named preset first, then launches it at the requested point; burst-mode presets fire as direct bursts, rocket-mode presets keep their rocket flight, and it honors count for repeated same-point launches.Сначала разрешает именованный пресет, затем запускает его в заданной точке; burst-режимы работают как прямые взрывы, rocket-режимы сохраняют полет ракеты, и учитывается count для повторного запуска в одной точке.
launchRocketAt(x, y, options?) Launches a rocket toward a target point.Запускает ракету к целевой точке (движок сам выбирает старт).
launchRocketFromTo(x1,y1, x2,y2, opt?) Launches a rocket from a fixed start point to a fixed target point.Запуск ракеты из фиксированной точки старта к цели.
launchRocket(options?) Launches rockets as a batch. Use count to control the batch size.Массовый запуск ракет (можно использовать count для пакета).

Presets (Готовые пресеты)

These are authored bundles, not the same thing as raw engine defaults.

Это авторские сборки настроек, отличающиеся от сырых дефолтов движка.

This table covers the engine start presets used by startPreset(name). Point-based launch presets are listed below and launched through launchPresetAt(name, x, y).

Эта таблица описывает стартовые пресеты движка, которые используются в startPreset(name). Точечные launch-пресеты перечислены ниже и запускаются через launchPresetAt(name, x, y).

Preview is idle. Preview не запущен.

Preset IntentНазначение Preview
'base' One direct burst.Один прямой взрыв.
'rocket' Two rockets with visible flight and tail embers. Две ракеты с видимым полетом и шлейфом.
'cascade' Two rockets; each rocket emits three follow-up cascade bursts.Две ракеты; каждая создает три последующих каскадных взрыва.
'finale' Dense finale with twenty rockets across a short show window.Плотный финал: двадцать ракет за короткий промежуток.

The four engine presets above are scheduled scene starters. They choose their launch targets internally; when a preset uses rocket flight, the rocket start point is also selected by the runtime. Use them when you want a ready-made show rather than a point-targeted reaction.

Четыре engine-пресета выше запускают готовую сцену по расписанию. Они сами выбирают точки целей; если пресет использует полет ракеты, точка старта ракеты тоже выбирается runtime. Используйте их, когда нужен готовый эффект, а не реакция в конкретной точке.

Launch presets

Preset IntentНазначение Preview
'button-click' One compact direct spark burst with 30 sparks and no rocket.Один компактный прямой burst: 30 искр, без ракеты.
'success-burst' One direct success burst with 30 glyph forms, 30 sparks, and a center flash.Один прямой success-burst: 30 glyph-форм, 30 искр и центральная вспышка.
'win-celebration' One rocket that spawns three child rockets; each child rocket creates its own burst plus one follow-up cascade burst.Одна ракета создает три дочерние ракеты; каждая дочерняя ракета дает свой основной взрыв плюс один последующий каскадный взрыв.
'achievement-unlock' One wide confetti fan made from three close direct bursts with different directions.Один широкий веер конфетти, собранный из трех близких прямых burst-запусков с разными направлениями.
'confetti-pop' Two side cannons, each launching a 110-piece confetti burst.Две боковые пушки, каждая запускает burst из 110 частиц конфетти.
'purchase-success' One Rocket Bloom launch: a single rocket opens into 16 child rockets; each child creates its own compact spark burst plus one follow-up cascade burst.Один запуск Rocket Bloom: одиночная ракета раскрывается в 16 дочерних ракет; каждая дочерняя дает свой компактный spark-взрыв плюс один последующий каскадный взрыв.
'victory-finale' One finale rocket that spawns six child rockets; each child rocket creates its own burst plus three follow-up cascade bursts.Одна финальная ракета создает шесть дочерних ракет; каждая дочерняя ракета дает свой основной взрыв плюс три последующих каскадных взрыва.
'snowfall' Continuous falling glyph scene: 6 flakes per wave, repeating until the engine is stopped.Непрерывная сцена падающих glyph-частиц: 6 снежинок за волну, повторяется до остановки engine.
'leaf-fall' Continuous falling UTF leaf scene: 5 warm leaf glyphs per wave, repeating until the engine is stopped.Непрерывный листопад из UTF-глифов: 5 теплых листьев за волну, повторяется до остановки engine.
'ambient-sparkle' Continuous star-like sparkle background, refreshed with two twinkle-cloud pulses until the engine is stopped.Непрерывный фон из мерцающих звезд: два twinkle-cloud импульса повторяются до остановки engine.

Practical tuning order (Порядок настройки)

If you only want to change one thing at a time, tune in this order:

Если вы хотите менять настройки поэтапно (по одной вещи за раз), следуйте этому порядку:

Order What to touch firstЧто изменять первым
1 rocket.enabled, burstForms.enabled, burstSparks.enabled, burstCenterFlash.enabled, burstTwinkleCloud.enabled
2 burstForms.count, burstSparks.count, burstTwinkleCloud.count, rocketTailEmbers.count
3 rocket.colorMode, burstForms.colorMode, burstSparks.colorMode, burstCenterFlash.colorMode
4 rocket.speed, rocket.durationMin, rocket.durationMax
5 rocket.cascade.*
6 timeScale, sizeScale
7 performance.* only if you are chasing a specific load issue performance.* (Только если есть проблемы с производительностью)