steam_is_overlay_activated

Check to see if the overlay is currently active.

Syntax:

GML Code Example

steam_is_overlay_activated();


Returns: Boolean


Description

This function can be used to find out if the user has the Steam Overlay active or not. If the overlay is active and visible to the user the function will return true, and if it is not, then it will return false. An example of what this function can be used for would be for polling the Steam API for the overlay so that you can pause your game while the overlay is being shown.


Example:

GML Code Example

if steam_is_overlay_activated()
    {
    global.Pause = true;
    }
 

The above code will check to see if the Steam overlay is active and if it is it will set the global variable "Pause" to true.





No Examples Submitted

Does this page need better examples? Be the first to Submit

No Edits Suggested

Is this page unclear or not descriptive enough? Suggest an edit to the page and with enough upvotes your changes will be made.

No Questions Have Been Ask

Do you have a question about this page? Ask it Here