Search Results for

    Show / Hide Table of Contents

    Overlay

    The KaijuOverlay class contains methods for interacting with the Steam overlay. The API has been streamlined to be more convienient than the native Steamworks overlay API, ensuring you don't need to worry about passing in specific string keys.

    The KaijuUser class has the KaijuUser.Overlay() method which can be called to open the overlay to the Steam user's profile page.

    The Steam overlay does not work in the Unity editor or in builds not launched directly through Steam. This is a limitation of Steamworks and by extension Steamworks.NET which KMPE is built upon. However, while in the editor, KMPE will log messages in place of opening editor windows, allowing you to validate you have for instance bound buttons correctly to open specific overlay pages.

    Disable Overlay

    If you are using a different system for interacting with the Steamworks overlay in your project, you can disable KMPE's overlay system by setting the DISABLE_KAIJU_OVERLAY preprocessor directives in your project. This will strip all code releated to KMPE's overlay system. You can do this by going to Tools > Kaiju Solutions > Multiplayer Engine > Features > Overlay > Disable from the top menu, or manually adding or removing it from the preprocessor directives by going to Edit > Project Settings from the top menu, selecting Player, and scrolling down to Scripting Define Symbols.

    In This Article
    Back to top © 2025 Kaiju Solutions Inc.