src/social_integration.h

   1 /*
   2  * This file is part of OpenTTD.
   3  * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
   4  * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
   5  * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
   6  */
   7
   8 /** @file social_integration.h Interface definitions for game to report/respond to social integration. */
   9
  10 #ifndef SOCIAL_INTEGRATION_H
  11 #define SOCIAL_INTEGRATION_H
  12
  13 class SocialIntegrationPlugin {
  14 public:
  15         enum State {
  16                 RUNNING, ///< The plugin is successfully loaded and running.
  17
  18                 FAILED, ///< The plugin failed to initialize.
  19                 PLATFORM_NOT_RUNNING, ///< The plugin failed to initialize because the Social Platform is not running.
  20                 UNLOADED, ///< The plugin is unloaded upon request.
  21                 DUPLICATE, ///< Another plugin of the same Social Platform is already loaded.
  22                 UNSUPPORTED_API, ///< The plugin does not support the current API version.
  23                 INVALID_SIGNATURE, ///< The signature of the plugin is invalid.
  24         };
  25
  26         std::string basepath; ///< Base path of the plugin.
  27
  28         std::string social_platform = "unknown"; ///< Social platform this plugin is for.
  29         std::string name = ""; ///< Name of the plugin.
  30         std::string version = ""; ///< Version of the plugin.
  31
  32         State state = FAILED; ///< Result of the plugin's init function.
  33
  34         SocialIntegrationPlugin(const std::string &basepath) : basepath(basepath) {}
  35 };
  36
  37 class SocialIntegration {
  38 public:
  39         /**
  40          * Get the list of loaded social integration plugins.
  41          */
  42         static std::vector<SocialIntegrationPlugin *> GetPlugins();
  43
  44         /**
  45          * Initialize the social integration system, loading any social integration plugins that are available.
  46          */
  47         static void Initialize();
  48
  49         /**
  50          * Shutdown the social integration system, and all social integration plugins that are loaded.
  51          */
  52         static void Shutdown();
  53
  54         /**
  55          * Allow any social integration library to handle their own events.
  56          */
  57         static void RunCallbacks();
  58
  59         /**
  60          * Event: user entered the main menu.
  61          */
  62         static void EventEnterMainMenu();
  63
  64         /**
  65          * Event: user entered the Scenario Editor.
  66          */
  67         static void EventEnterScenarioEditor(uint map_width, uint map_height);
  68
  69         /**
  70          * Event: user entered a singleplayer game.
  71          */
  72         static void EventEnterSingleplayer(uint map_width, uint map_height);
  73
  74         /**
  75          * Event: user entered a multiplayer game.
  76          */
  77         static void EventEnterMultiplayer(uint map_width, uint map_height);
  78
  79         /**
  80          * Event: user is joining a multiplayer game.
  81          */
  82         static void EventJoiningMultiplayer();
  83 };
  84
  85 #endif /* SOCIAL_INTEGRATION_H */