steamworks.showStoreOverlay()

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

Overview

Displays a Steam overlay on top of the application window. This overlay shows a web page displaying information about one particular game on the Steam store. You would normally use this function to advertise other games on Steam.

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.showStoreOverlay( [appId] )
appId (optional)

String. Unique string ID of the application assigned by Steam. The overlay will show this application's web page on the Steam store. If you do not provide this argument, the overlay will display the currently running application's store page.

Example

local steamworks = require( "plugin.steamworks" )

-- Attempt to show this game's Steam store web page as an overlay
local wasShown = steamworks.showStoreOverlay()

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