d1/de4/script__suspend_8hpp_source.html

/*

 * This file is part of OpenTTD.

 * 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.

 * 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.

 * 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/>.

 */


#ifndef SCRIPT_SUSPEND_HPP

#define SCRIPT_SUSPEND_HPP


typedef void (Script_SuspendCallbackProc)(class ScriptInstance *instance);


class Script_Suspend {

public:


  Script_Suspend(int time, Script_SuspendCallbackProc *callback) :

    time(time),

    callback(callback)

  {}


  int GetSuspendTime() { return time; }


  Script_SuspendCallbackProc *GetSuspendCallback() { return callback; }


private:

  int time;

  Script_SuspendCallbackProc *callback;

};


#endif /* SCRIPT_SUSPEND_HPP */

ScriptInstance
Runtime information about a script like a pointer to the squirrel vm and the current state.
Definition script_instance.hpp:25

ScriptInstance::instance
SQObject * instance
Squirrel-pointer to the script main class.
Definition script_instance.hpp:288

Script_Suspend
A throw-class that is given when the script wants to suspend.
Definition script_suspend.hpp:21

Script_Suspend::callback
Script_SuspendCallbackProc * callback
Callback function to call when the script can run again.
Definition script_suspend.hpp:47

Script_Suspend::time
int time
Amount of ticks to suspend the script.
Definition script_suspend.hpp:46

Script_Suspend::GetSuspendTime
int GetSuspendTime()
Get the amount of ticks the script should be suspended.
Definition script_suspend.hpp:37

Script_Suspend::GetSuspendCallback
Script_SuspendCallbackProc * GetSuspendCallback()
Get the callback to call when the script can run again.
Definition script_suspend.hpp:43

Script_Suspend::Script_Suspend
Script_Suspend(int time, Script_SuspendCallbackProc *callback)
Create the suspend exception.
Definition script_suspend.hpp:28

Script_SuspendCallbackProc
void() Script_SuspendCallbackProc(class ScriptInstance *instance)
The callback function when a script suspends.
Definition script_suspend.hpp:16