OpenTTD Source: src/script/script_suspend.hpp Source File

OpenTTD Source 13.2.1

script_suspend.hpp
Go to the documentation of this file.
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
10 #ifndef SCRIPT_SUSPEND_HPP
11 #define SCRIPT_SUSPEND_HPP
12
16 typedef void (Script_SuspendCallbackProc)(class ScriptInstance *instance);
17
21 class Script_Suspend {
22 public:
28 Script_Suspend(int time, Script_SuspendCallbackProc *callback) :
29 time(time),
30 callback(callback)
31 {}
32
37 int GetSuspendTime() { return time; }
38
43 Script_SuspendCallbackProc *GetSuspendCallback() { return callback; }
44
45 private:
46 int time;
47 Script_SuspendCallbackProc *callback;
48 };
49
50 #endif /* SCRIPT_SUSPEND_HPP */
Script_Suspend
A throw-class that is given when the script wants to suspend.
Definition: script_suspend.hpp:21
Script_Suspend::Script_Suspend
Script_Suspend(int time, Script_SuspendCallbackProc *callback)
Create the suspend exception.
Definition: script_suspend.hpp:28
Script_Suspend::GetSuspendTime
int GetSuspendTime()
Get the amount of ticks the script should be suspended.
Definition: script_suspend.hpp:37
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:283
Script_SuspendCallbackProc
void() Script_SuspendCallbackProc(class ScriptInstance *instance)
The callback function when a script suspends.
Definition: script_suspend.hpp:16
Script_Suspend::time
int time
Amount of ticks to suspend the script.
Definition: script_suspend.hpp:46
Script_Suspend::GetSuspendCallback
Script_SuspendCallbackProc * GetSuspendCallback()
Get the callback to call when the script can run again.
Definition: script_suspend.hpp:43
Script_Suspend::callback
Script_SuspendCallbackProc * callback
Callback function to call when the script can run again.
Definition: script_suspend.hpp:47