src/game/game_instance.cpp

   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 game_instance.cpp Implementation of GameInstance. */
   9
  10 #include "../stdafx.h"
  11 #include "../error.h"
  12
  13 #include "../script/squirrel_class.hpp"
  14
  15 #include "../script/script_storage.hpp"
  16 #include "../script/script_cmd.h"
  17 #include "../script/script_gui.h"
  18 #include "game_config.hpp"
  19 #include "game_info.hpp"
  20 #include "game_instance.hpp"
  21 #include "game_text.hpp"
  22 #include "game.hpp"
  23
  24 /* Convert all Game related classes to Squirrel data. */
  25 #include "../script/api/game/game_includes.hpp"
  26
  27 #include "../safeguards.h"
  28
  29
  30 GameInstance::GameInstance() :
  31         ScriptInstance("GS")
  32 {}
  33
  34 void GameInstance::Initialize(GameInfo *info)
  35 {
  36         this->versionAPI = info->GetAPIVersion();
  37
  38         /* Register the GameController */
  39         SQGSController_Register(this->engine);
  40
  41         ScriptInstance::Initialize(info->GetMainScript(), info->GetInstanceName(), OWNER_DEITY);
  42 }
  43
  44 void GameInstance::RegisterAPI()
  45 {
  46         ScriptInstance::RegisterAPI();
  47
  48         /* Register all classes */
  49         SQGS_RegisterAll(this->engine);
  50
  51         RegisterGameTranslation(this->engine);
  52
  53         if (!this->LoadCompatibilityScripts(this->versionAPI, GAME_DIR)) this->Died();
  54 }
  55
  56 int GameInstance::GetSetting(const std::string &name)
  57 {
  58         return GameConfig::GetConfig()->GetSetting(name);
  59 }
  60
  61 ScriptInfo *GameInstance::FindLibrary(const std::string &library, int version)
  62 {
  63         return (ScriptInfo *)Game::FindLibrary(library, version);
  64 }
  65
  66 void GameInstance::Died()
  67 {
  68         ScriptInstance::Died();
  69
  70         /* Don't show errors while loading savegame. They will be shown at end of loading anyway. */
  71         if (_switch_mode != SM_NONE) return;
  72
  73         ShowScriptDebugWindow(OWNER_DEITY);
  74
  75         const GameInfo *info = Game::GetInfo();
  76         if (info != nullptr) {
  77                 ShowErrorMessage(STR_ERROR_AI_PLEASE_REPORT_CRASH, INVALID_STRING_ID, WL_WARNING);
  78
  79                 if (!info->GetURL().empty()) {
  80                         ScriptLog::Info("Please report the error to the following URL:");
  81                         ScriptLog::Info(info->GetURL());
  82                 }
  83         }
  84 }
  85
  86 /**
  87  * DoCommand callback function for all commands executed by Game Scripts.
  88  * @param cmd cmd as given to DoCommandPInternal.
  89  * @param result The result of the command.
  90  * @param data Command data as given to Command<>::Post.
  91  * @param result_data Additional returned data from the command.
  92  */
  93 void CcGame(Commands cmd, const CommandCost &result, const CommandDataBuffer &data, CommandDataBuffer result_data)
  94 {
  95         if (Game::GetGameInstance()->DoCommandCallback(result, data, std::move(result_data), cmd)) {
  96                 Game::GetGameInstance()->Continue();
  97         }
  98 }
  99
 100 CommandCallbackData *GameInstance::GetDoCommandCallback()
 101 {
 102         return &CcGame;
 103 }