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.

FieldRequiredMeaning
IdYesUnique per product, shared across material and variant zones. A clash shows Duplicate ID. Don't change it once presets are shared.
Display NameNoLabel for visitors. Falls back to the ID.
Default OptionYes (has a fallback)Selected on load and on Reset. None, or a deleted ID, uses the first option.
Material OptionsMaterial zones, unless categories supply optionsThe finishes, in display order.
Material categoriesNoShared category assets this zone offers.
Ungrouped category labelNoName of the group holding the zone's own options when it has categories. Empty uses Standard.
Variant OptionsVariant zonesThe choices, in display order.

Each zone row's dropdown inserts a zone of the same kind above it, deletes it or duplicates it.

A material zone with an ID, default option and material options
A product zone groups the choices available for one configurable part of the product.

BAKR Material Option

FieldRequiredMeaning
IdYesUnique in the zone and across its categories. None is reserved.
Display NameNoLabel on the swatch. Falls back to the ID.
SwatchNoColor of the swatch button. Does not change the material. Sent to web clients as RRGGBBAA.
MaterialYesMaterial or material instance for the bound slots. Loaded asynchronously.
ScalarsNoNumber parameters to set, for example Roughness = 0.3. Applied in Play.
VectorsNoColor parameters to set, for example Tint. Applied in Play.
Incompatible WithNoOptions in other zones this option can't be combined with.
Also incompatible withRead onlyRules declared on other options that name this one.
Material option with a material, swatch and vector parameter
Material options define the finish and can override parameters on the chosen material.

BAKR Variant Option

FieldRequiredMeaning
IdYesUnique in the zone.
Display NameNoLabel in the picker.
DescriptionNoLonger text, sent in the catalog.
SourceYesScene actors or Streamed level.
Scene ActorsScene actors, unless linked by component or HiddenActors this option shows. Attached actors follow.
Linked by componentRead onlyActors linked through a BAKR Variant Actor component.
LevelStreamed level, unless HiddenThe level loaded while this option is chosen.
HiddenNoMakes this the "none" choice: every option's actors and levels hide.
Incompatible WithNoAs on material options.
Variant option configured with scene actors
Variant options connect a choice to scene actors or a streamed level.

BAKR Material Category

Data Asset: Add → Miscellaneous → Data Asset → BAKR Material Category.

FieldRequiredMeaning
IdYesUnique category name.
Display NameYesName on the category button.
OptionsYesMaterial options in picker order. IDs must be unique across all categories one zone uses.
Material category asset with its options
A material category collects finishes that can be shared across zones.

BAKR Style

Data Asset, usually created from Styles → Create New Asset → BAKR Style in step 05.

FieldRequiredMeaning
IdYesUnique among the product's styles. The web style command uses it.
Display NameYesName on the style's button.
SelectionYesMaterials and Variants maps of zone ID → option ID. Zones not listed keep their choice.
Style asset with material and variant choices
Styles combine choices from multiple zones into a curated configuration.

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.