steam_activate_overlay

Activate the Steam user interface overlay for your game.

Syntax:

GML Code Example

steam_activate_overlay(overlayindex);


Argument Description
overlayindex The page index of the Steam API UI to show (see constants listed below).


Returns: N/A


Description

The Steam overlay is a piece of the Steam user interface that can be activated over the top of almost any game launched through Steam. It lets the user access their friends list, web browser, chat, and in-game DLC purchasing. The default key for a user to access the overlay while in a game is SHIFT+TAB, but you can also bring up any page of the overlay using this function. It takes one of six constants that are listed below:

Constant Description
ov_friends The friends page for the current user
ov_community The community page for your game
ov_players The page showing others that are playing the same game or that you have recently played with
ov_settings The Steam client overlay settings
ov_gamegroup Opens the Steam Community web browser to the official game group for this game
ov_achievements The achievements page for your game


Example:

GML Code Example

var key = keyboard_lastkey;
 switch (key)
    {
    case vk_f1: steam_activate_overlay(ov_friends); break;
    case vk_f2: steam_activate_overlay(ov_community); break;
    case vk_f3: steam_activate_overlay(ov_players); break;
    case vk_f4: steam_activate_overlay(ov_settings); break;
    case vk_f5: steam_activate_overlay(ov_gamegroup); break;
    case vk_f6: steam_activate_overlay(ov_achievements); break;
    }
 

The above code polls the last keyboard key pressed and if it is any of the function keys from 1 to 6 it will open the corresponding page of the Steam overlay.





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