@3dsource/metabox-front-api
    Preparing search index...

    Class ShowOverlayInterface

    Represents a command to toggle the Unreal Overlay Interface Menu. This action sends a message to the Metabox API to toggle the visibility of the Unreal overlay UI.

    Shows the overlay interface elements. Displays UI controls and buttons overlaid on the 3D scene.

    Toggles viewport overlay controls (buttons overlaid on the 3D scene). Takes a boolean. Use ShowOverlayInterface(false) alongside ShowEmbeddedMenu(false) when building fully custom UI that replaces all native MetaBox controls.

    In standalone mode, overlays are already hidden. In default mode, call new ShowOverlayInterface(false) early in initialization to prevent flash of native UI. Always pair with ShowEmbeddedMenu(false) for clean custom UI. Pass true to restore if entering a mode that uses native controls.

    import { ShowOverlayInterface, Communicator } from '@3dsource/metabox-front-api';
    window.env3DSource.apiReady = (api: Communicator) => {
      api.sendCommandToMetabox(new ShowOverlayInterface(true));
    };

    A flag indicating whether the Unreal overlay UI should be visible.

    Index

    Constructors

    constructor

    Properties

    data

    Constructors

    Properties

    data: ToMetaBoxMessageEnvelope

    The message envelope populated by subclass constructors and sent via Communicator.sendCommandToMetabox.

    Settings

    Member Visibility

    On This Page

    What does it unlock?Practical ApplicationAI Coding Best Practices
    Constructors
    Properties