# `FireSpec`

> Contract 2.0.0 · package sha256 `a857eca95b35921109faf997094bb4192f12527d9d0fcd4be7e97f06425bad6e` · generated from `configurator-runtime.d.ts` by `services/onsite-scripter/scripts/build-contract-docs.mjs`; edit the source, not this file.

Interface · `import type { FireSpec } from '@holostep-configurators/runtime-client/contract';` · labs, `@experimental` · since 2.0.0 · section 20. Labs

Volumetric fire, as [`labs.fire`](Labs.fire.md) draws it.

## Members

| Member | Kind | Summary |
| --- | --- | --- |
| <a id="size"></a>[`size`](FireSpec.size.md) | property | Metres: the box the flame fills. |
| <a id="magnitude"></a>[`magnitude?`](FireSpec.magnitude.md) | property | Flame strength, relative; 1 is the tuned look. |
| <a id="color"></a>[`color?`](FireSpec.color.md) | property | The flame's colour. |
| <a id="detail"></a>[`detail?`](FireSpec.detail.md) | property | The noise that shapes the flame (fractal Brownian motion terms) and the ray-march steps. |
| <a id="draworder"></a>[`drawOrder?`](FireSpec.drawOrder.md) | property | Scene-wide draw order among transparent parts, as [`MaterialSpec.labs.drawOrder`](MaterialSpec.labs.md) (fire 1 before glass 2). |

## Declaration

```ts
export interface FireSpec {
  size: Point3;
  magnitude?: number;
  color?: ColorValue;
  detail?: {
    octaves?: number;
    lacunarity?: number;
    gain?: number;
    iterations?: number;
  };
  drawOrder?: number;
}
```

## Generic-API test (spec 3.1)

| Rule | Result |
| --- | --- |
| 1. Neutral name | pass: `FireSpec` names no product |
| 2. A precedent | pass: [Unity ParticleSystem](https://docs.unity3d.com/ScriptReference/ParticleSystem.html) (row `E2`) |
| 3. Two apps, or labs | labs (`@experimental` at a stable path, reached through `has()` or `supports()`): it graduates when a second app uses it; apps today: app-0c773a4ee3, app-b362a81c85 |
| 4. The cheaper fix first | decided per need in Appendix B: rows `E2`, `K24` at tier labs (a member only where no rule, data, asset or app code serves the need) |