Type Function Return value Boolean Revision Release 2024.3703 Keywords steam, steamworks, overlay, showWebOverlay See also steamworks.canShowOverlay steamworks.showGameOverlay() steamworks.showUserOverlay() steamworks.showStoreOverlay() steamworks.*
Displays a Steam overlay on top of the application window. This overlay shows Steam’s
Returns true
if Steam is able to display the overlay.
This function will return false
— and the overlay will not show — in the following cases:
false
.false
, indicating that the application is not currently connected to the Steam client.steamworks.showWebOverlay( [url] )
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.
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