Dispatches every time the configurator data is updated. I.e., when the user changes the configuration. (Material, Product, Environment)
Dispatches every time the ecom configurator data is updated (label, endpointUrl).
Dispatches every time when the User sends get camera command new GetCamera() command.
Dispatches when the loading progress or loader visibility changes.
percents is the smoothed progress value (0–100).
loaderVisible indicates whether the loading overlay is currently shown.
Dispatches every time when Unreal is sending an ordered render with a new GetScreenshot() command.
Dispatches every time when while the configurator loads. Shows showcase status information on a scene.
Dispatches at the moment while the configurator loads. Shows status information.
Dispatches when user inactivity (AFK) is detected and the countdown to disconnect begins.
remainingSecondsToDisconnect counts down (e.g. 15, 14, 13…) until the session is terminated.
countdownVisible indicates whether the AFK countdown popup is currently shown.
Dispatches every time when Unreal is changing its video stream size.
Dispatches periodically with aggregated video stream statistics.
Dispatches every time when the Unreal Viewport is visible/hidden.
Maps event names received from the Metabox iframe to their typed payloads. Used by Communicator.addEventListener to provide type-safe event subscriptions.
What does it unlock?
Message format for MetaBox communication protocol. Wraps data for transmission between API and MetaBox.
Practical Application
Payload type map for all incoming event types. Defines the data shape for each event name (configuratorDataUpdated, screenshotReady, viewportReady, etc.). Essential TypeScript reference for properly typing event handlers.
AI Coding Best Practices
Use as TypeScript type reference:
api.addEventListener('configuratorDataUpdated', (data: FromMetaboxMessagePayloads['configuratorDataUpdated']) => {...}). Key events and their types: configuratorDataUpdated→ConfiguratorEnvelope, screenshotReady→string|null, viewportReady→boolean, showcaseStatusChanged→ShowCaseStatus.