steamworks.showWebOverlay()

Type Function
Return value Boolean
Revision Current Public Release (2018.3326)
Keywords steam, steamworks, overlay, showWebOverlay
See also steamworks.canShowOverlay
steamworks.showGameOverlay()
steamworks.showUserOverlay()
steamworks.showStoreOverlay()
steamworks.*

Overview

Displays a Steam overlay on top of the application window. This overlay shows Steam's built-in web browser. You can use it to display a particular web page.

Returns true if Steam is able to display the overlay.

Gotchas

This function will return false — and the overlay will not show — in the following cases:

Syntax

steamworks.showWebOverlay( [url] )
url (optional)

String. The URL to load in the overlay's web browser. If you do not provide a URL argument, the overlay will show the web browser's last displayed page.

Example

local steamworks = require( "plugin.steamworks" )

-- Attempt to show our home page within the application
local wasShown = steamworks.showWebOverlay( "https://coronalabs.com" )

if not wasShown then
    print( "Failed to display the overlay." )
end