steamworks.canShowOverlay

Type Boolean
Revision 2018.3333
Keywords steam, steamworks, canShowOverlay
See also steamworks.showGameOverlay()
steamworks.showStoreOverlay()
steamworks.showUserOverlay()
steamworks.showWebOverlay()

Overview

This will be true if Steam overlays can be shown on top of the app. This means that Steam popup notifications can be shown and screen overlays can be shown via this plugin's APIs or by the user pressing the default Shift+Tab keys.

Gotchas

This property will be false in the following cases:

Example

local steamworks = require( "plugin.steamworks" )

print( "Can Show Steam Overlay: " .. tostring(steamworks.canShowOverlay) )