Reference
Zones, options and styles
Fields of every zone, option, category and style asset, with what is required.
Zones and their options are authored inline on the configurator in step 02, so most of them never exist as separate assets. Material categories and styles are reusable Data Assets.
Every field's tooltip in the editor says whether it is required or optional.
Product Zone
Created with Add material zone or Add variant zone. The button decides the zone's kind, and a zone stays in the group it was made in. To change kind, make a new zone in the other group.
| Field | Required | Meaning |
|---|---|---|
| Id | Yes | Unique per product, shared across material and variant zones. A clash shows Duplicate ID. Don't change it once presets are shared. |
| Display Name | No | Label for visitors. Falls back to the ID. |
| Default Option | Yes (has a fallback) | Selected on load and on Reset. None, or a deleted ID, uses the first option. |
| Material Options | Material zones, unless categories supply options | The finishes, in display order. |
| Material categories | No | Shared category assets this zone offers. |
| Ungrouped category label | No | Name of the group holding the zone's own options when it has categories. Empty uses Standard. |
| Variant Options | Variant zones | The choices, in display order. |
Each zone row's dropdown inserts a zone of the same kind above it, deletes it or duplicates it.
BAKR Material Option
| Field | Required | Meaning |
|---|---|---|
| Id | Yes | Unique in the zone and across its categories. None is reserved. |
| Display Name | No | Label on the swatch. Falls back to the ID. |
| Swatch | No | Color of the swatch button. Does not change the material. Sent to web clients as RRGGBBAA. |
| Material | Yes | Material or material instance for the bound slots. Loaded asynchronously. |
| Scalars | No | Number parameters to set, for example Roughness = 0.3. Applied in Play. |
| Vectors | No | Color parameters to set, for example Tint. Applied in Play. |
| Incompatible With | No | Options in other zones this option can't be combined with. |
| Also incompatible with | Read only | Rules declared on other options that name this one. |
BAKR Variant Option
| Field | Required | Meaning |
|---|---|---|
| Id | Yes | Unique in the zone. |
| Display Name | No | Label in the picker. |
| Description | No | Longer text, sent in the catalog. |
| Source | Yes | Scene actors or Streamed level. |
| Scene Actors | Scene actors, unless linked by component or Hidden | Actors this option shows. Attached actors follow. |
| Linked by component | Read only | Actors linked through a BAKR Variant Actor component. |
| Level | Streamed level, unless Hidden | The level loaded while this option is chosen. |
| Hidden | No | Makes this the "none" choice: every option's actors and levels hide. |
| Incompatible With | No | As on material options. |
BAKR Material Category
Data Asset: Add → Miscellaneous → Data Asset → BAKR Material Category.
| Field | Required | Meaning |
|---|---|---|
| Id | Yes | Unique category name. |
| Display Name | Yes | Name on the category button. |
| Options | Yes | Material options in picker order. IDs must be unique across all categories one zone uses. |
BAKR Style
Data Asset, usually created from Styles → Create New Asset → BAKR Style in step 05.
| Field | Required | Meaning |
|---|---|---|
| Id | Yes | Unique among the product's styles. The web style command uses it. |
| Display Name | Yes | Name on the style's button. |
| Selection | Yes | Materials and Variants maps of zone ID → option ID. Zones not listed keep their choice. |
Selection and presets
A selection is two maps: Materials (zone → option) and Variants (zone → option). Presets are JSON version 2:
{
"version": 2,
"product": "Lamp",
"materials": { "Shade": "Red" },
"variants": { "Base": "Round" }
}
Missing zones use the catalog defaults. Unknown zone or option IDs, broken compatibility rules and missing slots reject the whole preset before anything changes.
Option compatibility reference
A rule is a Zone + Option pair (FBAKROptionRef). Option IDs are only unique within a zone, so a reference always names both. Rules apply both ways. See Compatibility rules.