steam_is_overlay_enabled

Check the Steam client API to see if the overlay functionality is enabled.

Syntax:

steam_is_overlay_enabled();


Returns: Boolean


Description

When using the Steam API, this function can be called to check that the Steam client API has the overlay functionality enabled.


Example:

global.steam_api = false;
if steam_initialised()
   {
   if steam_stats_ready() && steam_is_overlay_enabled()
      {
      global.steamapi = true;
      }
   }

The above code will set a global variable to true if the Steam client API is correctly initialised, along with the Steam statistics and overlay functionality, or it will set the variable to false otherwise.


Back: Steam API
Next: steam_is_overlay_activated
© Copyright YoYo Games Ltd. 2018 All Rights Reserved