Reference

Blueprint API

The nodes and events for driving a product from your own Blueprint logic: selection, cameras, motion, presets, the product switcher, UI building blocks and scripted batch renders.

Every entry is a normal Blueprint node or event. Get references from the placed BAKR Configurator: its State and Motion components, and the player's pawn cast to BAKRCameraPawn.

Selection (State component)

NodeKindNotes
Set Material (Zone, Option Id)CallableReturns true when accepted for loading.
Set Variant (Zone, Option Id)CallableA streamed level keeps the state busy until it has loaded.
Apply Style (Style Id)Callable
Apply Selection (Selection)CallableChange several zones in one atomic step.
Reset To DefaultsCallable
Get SelectionPureWhat is applied now.
Get Requested SelectionPureIncludes pending requests.
Get Default SelectionPureThe catalog defaults.
Get Effective Material / Variant (Zone)PureThe committed option object.
Is Option Available (Zone, Option Id)PureFalse when a compatibility rule blocks it.
Get Unavailable Reason (Zone, Option Id)PureNames the conflicting option.

A request that breaks a rule, names an unknown ID or hits a missing slot is refused as a whole. On Error fires and nothing changes.

Blueprint action nodes for setting materials and variants, resetting defaults, applying styles and selections, focusing the HUD, connecting a product, executing commands and skipping the intro
Action nodes change product choices and control their presentation from Blueprint.

Set a variant from Blueprint

Get the configurator's State component and call Set Variant with a zone ID and one of that zone's option IDs. Replace WheelTypes and Premium with IDs from your own product.

Blueprint example calling Set Variant on the configurator State component for the Premium option in the WheelTypes zone
Use Set Variant to switch a product part from your own UI or gameplay logic, such as choosing a wheel design, strap or accessory.

Reset the product from Blueprint

Call Reset To Defaults on the same State component to restore the product's catalog defaults.

Blueprint example calling Reset to Defaults on the configurator State component
Use Reset To Defaults for a reset button or to return the product to its starting material and variant choices before a new visitor begins.

Check option availability

Blueprint checking whether the Chrome option is available in BodyPaint before applying it, with an unavailable reason for blocked choices
Use availability checks to disable incompatible choices in a custom UI and explain why a finish cannot be selected.

Apply a style

Blueprint applying a style through the configurator State component
Use Apply Style to offer curated looks or packages that set several product choices together.

Catalog (State component)

NodeKindNotes
CatalogPropertyThe product's zones.
StylesPropertyThe product's styles.
Get Material Zones / Get Variant ZonesPureZone IDs.
Get Material Options / Get Variant Options (Zone)PureOption objects in display order.
Get Material Categories (Zone)PureId, Display Name and Option Ids per category. Empty for a flat zone.
Get Option Category (Zone, Option Id)PureBAKR.Ungrouped for the zone's own options.
Get Zone Label (Zone)Pure
Has Configurable ZonesPureTrue when any zone offers a choice.
Validate SetupCallableRuntime check; outputs the error list.
Blueprint query nodes for selections, material and variant zones, options, categories, availability, cameras, active products and product switcher entries, alongside validation and catalog export nodes
Query nodes provide product choices, camera views and availability information for a custom configurator interface.

List configurable zones

Blueprint listing variant zones and reading each zone label
Use zone queries to build menus and section headings from the product catalog instead of maintaining a separate list.

Validate the product setup

Blueprint validating the configurator setup and reading the returned errors
Use Validate Setup to check a product at runtime and surface setup errors in your own diagnostic tools.

Events (State component)

EventWhen
On ReadyThe product has initialized.
On State ChangedA change was applied.
On Busy ChangedLoading starts or ends.
On ErrorA request was refused or failed.
On Catalog ChangedInitialize rebuilt the zones.

Also readable: Ready, Busy and Last Error.

Blueprint delegate binding nodes for state changes, readiness, loading, errors, catalog changes, panel visibility, commands, JSON responses and intro events, plus Handle Json Command and Play Product Intro
Events let your Blueprint respond to product readiness, selection changes, loading, errors and presentation updates.

Respond to selection changes and errors

Blueprint binding callbacks to On State Changed and On Error on the State component
Use state events to refresh your UI after a choice is applied and show feedback when a request fails.

Presets (State component)

NodeNotes
Export Json / Import JsonVersion 2 preset strings.

Export the current selection

Get State from the placed configurator and use Export Json to read the current configuration as a preset string. Pass a saved preset string to Import Json to restore it.

Blueprint example exporting the configurator's current selection as JSON
Use Export Json to save a configuration, share it with another system or record it for debugging. Import Json restores the saved choices later.

Store a configuration

Blueprint storing the current selection JSON in a Saved Preset variable
Store the exported JSON to let visitors keep a configuration for later; use your own save system to retain it between sessions.

Restore a configuration

Blueprint importing a saved JSON preset through the State component
Use Import Json to restore saved choices, reload a shared configuration or return to an earlier selection.

Configurator actor

NodeNotes
Get POIsThis product's cameras in camera-bar order.
Find POI (Id)
Get POI For Zone (Zone)The camera linked to a zone, or none. For your own jump-to-camera button.
Get Start POI / Get Intro Overview POI
Set Product Visible (bool)Hides or shows the product and its scene actors, collision included.
Configuration ReadyEvent to implement in a Blueprint child.

Show or hide a product

Blueprint toggling the configurator product visibility
Use Set Product Visible to show or hide a product and its associated scene actors as part of a presentation or custom showroom flow.

Camera pawn

NodeKindNotes
Switch POI (POI, Instant)Callable
Active POIProperty
On POI ChangedEventAfter a switch is committed.
On POI Transition Begin / EndOverridable eventIn a pawn Blueprint child, for sound or UI on flights.
Orbit / Zoom / Set Panel Visible / Notify InteractionCallableFor a custom input scheme.
Is Camera Locked / Is Flying / Is Panel VisiblePureIs Panel Visible is false when no UI is created, and the product is then framed centered.
Set Reduced Motion / Clear Reduced Motion Override / Is Reduced MotionCallable / PureRuntime comfort switch.
Is Fading / Get Fade Phase / Get Fade Alpha / Get Pending POIPureInterior fade state.
On Fade ChangedEventAlpha and color, for drawing the fade yourself where there is no camera manager.
Get Global SettingsPure

Move to a part's camera

Blueprint finding the camera linked to a zone and switching the BAKR camera pawn to it
Use a zone's linked camera to focus on the part a visitor wants to inspect, such as wheels, trim or an interior detail.

Respond to camera changes

Blueprint binding On POI Changed and reading the new camera object's name
Use On POI Changed to update camera indicators, labels or contextual controls when the active view changes.

Motion component

NodeNotes
Play Sequence (Id, Reverse)Waits for a running sequence to return to rest first.
Stop / Pause / Resume
Get Active Sequence Id / Get ProgressProgress is 0 to 1, and 0 when idle.
Is Sequence Playing (Id, Reverse) / Is Sequence Paused (Id)
On Playback EventSequence Id and status: Playing, Waiting, Paused, Stopped, Finished.
SequencesThe configured entries.

Play and reverse an animation

Blueprint playing the DoorLeft sequence forward and in reverse through the Motion component
Use motion sequences to open and close doors, unfold parts or demonstrate a product mechanism from your own controls.

Controller and product switcher

NodeWhereNotes
Switch Product (Product Id)ControllerFalse for an unknown or active product, while loading, or during a switch.
Is Switching Product / Return To Startup ProductController
Play Product Intro / Skip Intro / Is Intro PlayingController
On Intro Started / On Intro FinishedControllerFinished reports whether it was skipped.
Handle Json Command / Export Catalog Json / On Json ResponseControllerUse the Web API from any transport.
Execute CommandControllerNative command without JSON.
Get Switchable Products / Find Product / Get Active Product / Has Product SwitcherBAKR Product SubsystemA world subsystem.
On Active Product ChangedBAKR Product SubsystemSwap sky, music or lighting per product.

Switch products

Blueprint requesting a different product through BAKRPlayerController
Use Switch Product to connect a custom product menu, showroom selector or comparison flow to the configurator.

Respond to product switches

Blueprint binding On Active Product Changed on the BAKR Product Subsystem
Use On Active Product Changed to update lighting, music, labels or other presentation elements for the newly active product.

Send a JSON command

Blueprint passing a variant selection command to Handle Json Command on the BAKR controller
Use Handle Json Command to route commands from a custom integration through the same interface used by web and kiosk clients.

Receive JSON responses

Blueprint binding a callback to On Json Response on the BAKR controller
Use On Json Response to return command results and status updates to an external interface or integration.

Custom HUD (BAKRHUDWidget)

NodeNotes
Catalog Changed / Status ChangedEvents to implement.
Request Command (Command, Zone, Id)Sends a choice or action through the controller.
Set Panel Visible / On Panel Visibility Changed
Select Category (Zone, Category Id)Filters a zone's panel; changes nothing.
Focus Zone / Focus POI
Product, Focused Zone, Active POI Id, StatusReadable state.
Get Switcher Entries / Has Product Switcher / Is Switching ProductFor your own switcher.
Run Action (Action)Does what a BAKR Button with that Action would.
Is Action Available / Is Action Active (Action)Whether the action has something to do, and whether its state is on (page open, panel in, menu open).
Has Action Button (Action)Whether a BAKR Button with that Action sits inside the HUD.

UI building blocks

The buttons from Customize the UI. Their nodes are under BAKR in the Blueprint context menu.

NodeKindNotes
Action, Label, Collapse When Unavailable, Selected Style, Selected Label ColorPropertiesOn a BAKR Button (WBP_BAKRButton, WBP_BAKRPrimaryButton, WBP_BAKRTab).
Selected / AvailableRead-onlyKept current by the HUD for a BAKR Button. The option, sequence and camera buttons keep their own current, with or without a HUD.
On Clicked (Button)EventOn every BAKR button, after it has done its job. Use with Action None for your own behavior.
State ChangedEventAfter Selected or Available is updated.
Press / Set Label / Get HUDCallable / PureOn a BAKR Button.
Kind, Zone, Option IDPropertiesOn a BAKR Option Button. Exposed on spawn.
Get Material Option / Get Variant OptionPureOn a BAKR Option Button. The option it sets, for a thumbnail or description; empty for the other kind or an unknown ID.
Sequence ID, ActionPropertiesOn a BAKR Sequence Button. Exposed on spawn. Action is Play, Reverse, Pause or Stop.
Camera IDPropertyOn a BAKR Camera Button. Exposed on spawn.
Get ProductPureOn the option, sequence and camera buttons. The product their player is configuring.
SyncCallableOn every BAKR button. Re-reads its state; call it after changing what a button targets once it is on screen.
Row ChangedEventOn a BAKR Summary Row, after it is filled. Reads Zone, Value, Changed, Has Swatch, Swatch.

Batch render (editor only)

For Python and Editor Utility Blueprints, under BAKR → Batch render. Not available in a packaged game. See Batch-render 2D images.

NodeKindNotes
Start Batch Render (Product, POIs, Varying Zones, Option Categories)CallableIDs throughout; empty POIs renders every camera, empty Option Categories every option. Renderer and quality come from the saved window settings. False with Error when it cannot start.
Is Batch Render RunningCallableWith Done and Total.
Cancel Batch RenderCallable

Typical patterns

  • Animate on a choice: bind On State Changed, compare Get Effective Variant, call Play Sequence.
  • Per-product ambience: bind On Active Product Changed on the product subsystem.
  • Your own transport: call Handle Json Command with a JSON string and bind On Json Response.

Animate in response to a choice

Blueprint reacting to On State Changed and playing a sequence when the effective spoiler variant is Raised
Combine selection events with Motion to animate a feature when a particular option is chosen, such as raising a spoiler.