steam_initialised

Check the Steam client API to see if it's been started.

Syntax:

steam_initialised();


Returns: Boolean


Description

When using the Steam API, this function can be called to check that the Steam client API has been initialised correctly before any doing any further calls to Steam specific functions in your game.


Example:

global.steam_api = false;
if steam_initialised()
   {
   if steam_stats_ready() && steam_is_overlay_enabled()
      {
      global.steam_api = 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_stats_ready
© Copyright YoYo Games Ltd. 2018 All Rights Reserved