OpenTTD

script_suspend.hpp
Go to the documentation of this file.
1 /* $Id: script_suspend.hpp 23378 2011-11-30 14:02:15Z truebrain $ */
2
3 /*
4 * This file is part of OpenTTD.
5 * 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.
6 * 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.
7 * 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/>.
8 */
9
12 #ifndef SCRIPT_SUSPEND_HPP
13 #define SCRIPT_SUSPEND_HPP
14
18 typedef void (Script_SuspendCallbackProc)(class ScriptInstance *instance);
19
23 class Script_Suspend {
24 public:
30 Script_Suspend(int time, Script_SuspendCallbackProc *callback) :
31 time(time),
32 callback(callback)
33 {}
34
39 int GetSuspendTime() { return time; }
40
45 Script_SuspendCallbackProc *GetSuspendCallback() { return callback; }
46
47 private:
48 int time;
49 Script_SuspendCallbackProc *callback;
50 };
51
52 #endif /* SCRIPT_SUSPEND_HPP */
Script_Suspend::Script_Suspend
Script_Suspend(int time, Script_SuspendCallbackProc *callback)
Create the suspend exception.
Definition: script_suspend.hpp:30
Script_Suspend::GetSuspendTime
int GetSuspendTime()
Get the amount of ticks the script should be suspended.
Definition: script_suspend.hpp:39
Script_Suspend::time
int time
Amount of ticks to suspend the script.
Definition: script_suspend.hpp:48
Script_Suspend
A throw-class that is given when the script wants to suspend.
Definition: script_suspend.hpp:23
ScriptInstance
Runtime information about a script like a pointer to the squirrel vm and the current state...
Definition: script_instance.hpp:25
Script_Suspend::callback
Script_SuspendCallbackProc * callback
Callback function to call when the script can run again.
Definition: script_suspend.hpp:49
Script_Suspend::GetSuspendCallback
Script_SuspendCallbackProc * GetSuspendCallback()
Get the callback to call when the script can run again.
Definition: script_suspend.hpp:45
Script_SuspendCallbackProc
void() Script_SuspendCallbackProc(class ScriptInstance *instance)
The callback function when a script suspends.
Definition: script_suspend.hpp:18
ScriptInstance::instance
SQObject * instance
Squirrel-pointer to the script main class.
Definition: script_instance.hpp:236