src/script/api/script_asyncmode.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 script_asyncmode.cpp Implementation of ScriptAsyncMode. */
   9
  10 #include "../../stdafx.h"
  11 #include "script_asyncmode.hpp"
  12 #include "../script_instance.hpp"
  13 #include "../script_fatalerror.hpp"
  14
  15 #include "../../safeguards.h"
  16
  17 bool ScriptAsyncMode::AsyncModeProc()
  18 {
  19         /* In async mode we only return 'true', telling the DoCommand it
  20          *  should stop run the command in asynchronous/fire-and-forget mode. */
  21         return true;
  22 }
  23
  24 bool ScriptAsyncMode::NonAsyncModeProc()
  25 {
  26         /* In non-async mode we only return 'false', normal operation. */
  27         return false;
  28 }
  29
  30 ScriptAsyncMode::ScriptAsyncMode(HSQUIRRELVM vm)
  31 {
  32         int nparam = sq_gettop(vm) - 1;
  33         if (nparam < 1) {
  34                 throw sq_throwerror(vm, "You need to pass a boolean to the constructor");
  35         }
  36
  37         SQBool sqasync;
  38         if (SQ_FAILED(sq_getbool(vm, 2, &sqasync))) {
  39                 throw sq_throwerror(vm, "Argument must be a boolean");
  40         }
  41
  42         this->last_mode     = this->GetDoCommandAsyncMode();
  43         this->last_instance = this->GetDoCommandAsyncModeInstance();
  44
  45         this->SetDoCommandAsyncMode(sqasync ? &ScriptAsyncMode::AsyncModeProc : &ScriptAsyncMode::NonAsyncModeProc, this);
  46 }
  47
  48 void ScriptAsyncMode::FinalRelease()
  49 {
  50         if (this->GetDoCommandAsyncModeInstance() != this) {
  51                 /* Ignore this error if the script is not alive. */
  52                 if (ScriptObject::GetActiveInstance()->IsAlive()) {
  53                         throw Script_FatalError("Asyncmode object was removed while it was not the latest *Mode object created.");
  54                 }
  55         }
  56 }
  57
  58 ScriptAsyncMode::~ScriptAsyncMode()
  59 {
  60         this->SetDoCommandAsyncMode(this->last_mode, this->last_instance);
  61 }