ryzom/client/src/steam_client.h

   1 // Ryzom - MMORPG Framework <http://dev.ryzom.com/projects/ryzom/>
   2 // Copyright (C) 2010  Winch Gate Property Limited
   3 //
   4 // This program is free software: you can redistribute it and/or modify
   5 // it under the terms of the GNU Affero General Public License as
   6 // published by the Free Software Foundation, either version 3 of the
   7 // License, or (at your option) any later version.
   8 //
   9 // This program is distributed in the hope that it will be useful,
  10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 // GNU Affero General Public License for more details.
  13 //
  14 // You should have received a copy of the GNU Affero General Public License
  15 // along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16
  17
  18 #ifndef CL_STEAM_CLIENT_H
  19 #define CL_STEAM_CLIENT_H
  20
  21 #include "nel/misc/types_nl.h"
  22 #include "nel/misc/dynloadlib.h"
  23
  24 /**
  25  * Steam API helper to be able to call Steam functions/methods without linking to any library.
  26  * The library is dynamically loaded and is optional.
  27  *
  28  * \author Cedric 'Kervala' OCHS
  29  * \date 2016
  30  */
  31 class CSteamClient
  32 {
  33 public:
  34         CSteamClient();
  35         ~CSteamClient();
  36
  37         /**
  38          *      Dynamically load Steam client library and functions pointers.
  39          *      Also retrieve authentication session ticket if available.
  40          *      If no authentication session ticket retrieved, returns false.
  41          */
  42         bool init();
  43
  44         /**
  45          *      Shutdown Steam client and unload library.
  46          */
  47         bool release();
  48
  49         /**
  50          *      Save current Language from Steam Settings
  51          */
  52         std::string GameLanguage;
  53
  54         std::string GameLanguageWebApiFormat();
  55
  56         /**
  57          *      Return the authentication session ticket if available.
  58          */
  59         std::string getAuthSessionTicket() const { return _AuthSessionTicket; }
  60
  61 private:
  62         // handle on Steam DLL
  63         NLMISC::NL_LIB_HANDLE _Handle;
  64
  65         // true if succeeded to initialize (must call shutdown)
  66         bool _Initialized;
  67
  68         // the retrieved authentication session ticket
  69         std::string _AuthSessionTicket;
  70 };
  71
  72 #endif