OpenTTD Source  20241108-master-g80f628063a
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 
17 
22 public:
29  time(time),
31  {}
32 
37  int GetSuspendTime() { return time; }
38 
44 
45 private:
46  int time;
48 };
49 
50 #endif /* SCRIPT_SUSPEND_HPP */
Runtime information about a script like a pointer to the squirrel vm and the current state.
SQObject * instance
Squirrel-pointer to the script main class.
A throw-class that is given when the script wants to suspend.
Script_SuspendCallbackProc * callback
Callback function to call when the script can run again.
int time
Amount of ticks to suspend the script.
int GetSuspendTime()
Get the amount of ticks the script should be suspended.
Script_Suspend(int time, Script_SuspendCallbackProc *callback)
Create the suspend exception.
Script_SuspendCallbackProc * GetSuspendCallback()
Get the callback to call when the script can run again.
void() Script_SuspendCallbackProc(class ScriptInstance *instance)
The callback function when a script suspends.