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

OpenTTD Source 14.0-RC3

script_instance.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_INSTANCE_HPP
11 #define SCRIPT_INSTANCE_HPP
12
13 #include <variant>
14 #include <squirrel.h>
15 #include "script_suspend.hpp"
16 #include "script_log_types.hpp"
17
18 #include "../command_type.h"
19 #include "../company_type.h"
20 #include "../fileio_type.h"
21
22 static const uint SQUIRREL_MAX_DEPTH = 25;
23
25 class ScriptInstance {
26 private:
28 enum SQSaveLoadType {
29 SQSL_INT = 0x00,
30 SQSL_STRING = 0x01,
31 SQSL_ARRAY = 0x02,
32 SQSL_TABLE = 0x03,
33 SQSL_BOOL = 0x04,
34 SQSL_NULL = 0x05,
35 SQSL_ARRAY_TABLE_END = 0xFF,
36 };
37
38 public:
39 friend class ScriptObject;
40 friend class ScriptController;
41
42 typedef std::variant<SQInteger, std::string, SQBool, SQSaveLoadType> ScriptDataVariant;
43 typedef std::list<ScriptDataVariant> ScriptData;
44
48 ScriptInstance(const char *APIName);
49 virtual ~ScriptInstance();
50
57 void Initialize(const std::string &main_script, const std::string &instance_name, CompanyID company);
58
64 virtual int GetSetting(const std::string &name) = 0;
65
72 virtual class ScriptInfo *FindLibrary(const std::string &library, int version) = 0;
73
78 void Continue();
79
83 void GameLoop();
84
88 void CollectGarbage();
89
93 class ScriptStorage *GetStorage();
94
98 ScriptLogTypes::LogData &GetLogData();
99
103 static void DoCommandReturn(ScriptInstance *instance);
104
108 static void DoCommandReturnVehicleID(ScriptInstance *instance);
109
113 static void DoCommandReturnSignID(ScriptInstance *instance);
114
118 static void DoCommandReturnGroupID(ScriptInstance *instance);
119
123 static void DoCommandReturnGoalID(ScriptInstance *instance);
124
128 static void DoCommandReturnStoryPageID(ScriptInstance *instance);
129
133 static void DoCommandReturnStoryPageElementID(ScriptInstance *instance);
134
138 static void DoCommandReturnLeagueTableID(ScriptInstance *instance);
139
143 static void DoCommandReturnLeagueTableElementID(ScriptInstance *instance);
144
148 class ScriptController *GetController() { return controller; }
149
153 inline bool IsDead() const { return this->is_dead; }
154
158 inline bool IsAlive() const { return !this->IsDead() && !this->in_shutdown; }
159
163 void Save();
164
168 static void SaveEmpty();
169
176 static ScriptData *Load(int version);
177
182 void LoadOnStack(ScriptData *data);
183
187 static void LoadEmpty();
188
194 void Pause();
195
200 bool IsPaused();
201
207 void Unpause();
208
214 SQInteger GetOpsTillSuspend();
215
225 bool DoCommandCallback(const CommandCost &result, const CommandDataBuffer &data, CommandDataBuffer result_data, Commands cmd);
226
231 void InsertEvent(class ScriptEvent *event);
232
238 bool IsSleeping() { return this->suspend != 0; }
239
240 size_t GetAllocatedMemory() const;
241
245 inline bool InShutdown() const { return this->in_shutdown; }
246
251 void ReleaseSQObject(HSQOBJECT *obj);
252
253 protected:
254 class Squirrel *engine;
255 std::string versionAPI;
256
260 virtual void RegisterAPI();
261
268 bool LoadCompatibilityScripts(const std::string &api_version, Subdirectory dir);
269
273 virtual void Died();
274
278 virtual CommandCallbackData *GetDoCommandCallback() = 0;
279
283 virtual void LoadDummyScript() = 0;
284
285 private:
286 class ScriptController *controller;
287 class ScriptStorage *storage;
288 SQObject *instance;
289
290 bool is_started;
291 bool is_dead;
292 bool is_save_data_on_stack;
293 int suspend;
294 bool is_paused;
295 bool in_shutdown;
296 Script_SuspendCallbackProc *callback;
297 size_t last_allocated_memory;
298
303 bool CallLoad();
304
315 static bool SaveObject(HSQUIRRELVM vm, SQInteger index, int max_depth, bool test);
316
321 static bool LoadObjects(ScriptData *data);
322
323 static bool LoadObjects(HSQUIRRELVM vm, ScriptData *data);
324 };
325
326 #endif /* SCRIPT_INSTANCE_HPP */
ScriptInstance::SQSL_ARRAY_TABLE_END
@ SQSL_ARRAY_TABLE_END
Marks the end of an array or table, no data follows.
Definition: script_instance.hpp:35
ScriptInstance::LoadDummyScript
virtual void LoadDummyScript()=0
Load the dummy script.
ScriptInstance::SaveObject
static bool SaveObject(HSQUIRRELVM vm, SQInteger index, int max_depth, bool test)
Save one object (int / string / array / table) to the savegame.
Definition: script_instance.cpp:354
ScriptInstance::engine
class Squirrel * engine
A wrapper around the squirrel vm.
Definition: script_instance.hpp:254
ScriptInstance::last_allocated_memory
size_t last_allocated_memory
Last known allocated memory value (for display for crashed scripts)
Definition: script_instance.hpp:297
ScriptStorage
The storage for each script.
Definition: script_storage.hpp:37
script_suspend.hpp
ScriptInstance::CallLoad
bool CallLoad()
Call the script Load function if it exists and data was loaded from a savegame.
Definition: script_instance.cpp:712
ScriptInstance::is_dead
bool is_dead
True if the script has been stopped.
Definition: script_instance.hpp:291
ScriptInstance::InsertEvent
void InsertEvent(class ScriptEvent *event)
Insert an event for this script.
Definition: script_instance.cpp:778
ScriptInstance::GameLoop
void GameLoop()
Run the GameLoop of a script.
Definition: script_instance.cpp:171
ScriptInstance::controller
class ScriptController * controller
The script main class.
Definition: script_instance.hpp:286
ScriptInstance::Save
void Save()
Call the script Save function and save all data in the savegame.
Definition: script_instance.cpp:476
CommandDataBuffer
std::vector< byte > CommandDataBuffer
Storage buffer for serialized command data.
Definition: command_type.h:465
ScriptInstance
Runtime information about a script like a pointer to the squirrel vm and the current state.
Definition: script_instance.hpp:25
ScriptInstance::ScriptInstance
ScriptInstance(const char *APIName)
Create a new script.
Definition: script_instance.cpp:52
ScriptInstance::Unpause
void Unpause()
Resume execution of the script.
Definition: script_instance.cpp:555
ScriptInstance::DoCommandReturnStoryPageElementID
static void DoCommandReturnStoryPageElementID(ScriptInstance *instance)
Return a StoryPageElementID reply for a DoCommand.
Definition: script_instance.cpp:298
ScriptInstance::instance
SQObject * instance
Squirrel-pointer to the script main class.
Definition: script_instance.hpp:288
Script_SuspendCallbackProc
void() Script_SuspendCallbackProc(class ScriptInstance *instance)
The callback function when a script suspends.
Definition: script_suspend.hpp:16
ScriptInstance::SQSL_STRING
@ SQSL_STRING
The following data is an string.
Definition: script_instance.hpp:30
ScriptInstance::is_save_data_on_stack
bool is_save_data_on_stack
Is the save data still on the squirrel stack?
Definition: script_instance.hpp:292
ScriptInstance::is_paused
bool is_paused
Is the script paused? (a paused script will not be executed until unpaused)
Definition: script_instance.hpp:294
ScriptInstance::GetLogData
ScriptLogTypes::LogData & GetLogData()
Get the log pointer of this script.
Definition: script_instance.cpp:319
ScriptInstance::DoCommandReturnLeagueTableElementID
static void DoCommandReturnLeagueTableElementID(ScriptInstance *instance)
Return a LeagueTableElementID reply for a DoCommand.
Definition: script_instance.cpp:303
Owner
Owner
Enum for all companies/owners.
Definition: company_type.h:18
ScriptInstance::DoCommandReturnLeagueTableID
static void DoCommandReturnLeagueTableID(ScriptInstance *instance)
Return a LeagueTableID reply for a DoCommand.
Definition: script_instance.cpp:308
ScriptInstance::GetOpsTillSuspend
SQInteger GetOpsTillSuspend()
Get the number of operations the script can execute before being suspended.
Definition: script_instance.cpp:749
ScriptInstance::Pause
void Pause()
Suspends the script for the current tick and then pause the execution of script.
Definition: script_instance.cpp:546
ScriptInstance::DoCommandReturnGoalID
static void DoCommandReturnGoalID(ScriptInstance *instance)
Return a GoalID reply for a DoCommand.
Definition: script_instance.cpp:288
ScriptInstance::ReleaseSQObject
void ReleaseSQObject(HSQOBJECT *obj)
Decrease the ref count of a squirrel object.
Definition: script_instance.cpp:791
ScriptInstance::storage
class ScriptStorage * storage
Some global information for each running script.
Definition: script_instance.hpp:287
ScriptInfo::version
int version
Version of the script.
Definition: script_info.hpp:152
ScriptInstance::IsAlive
bool IsAlive() const
Return whether the script is alive.
Definition: script_instance.hpp:158
Squirrel
Definition: squirrel.hpp:23
ScriptInstance::DoCommandReturnSignID
static void DoCommandReturnSignID(ScriptInstance *instance)
Return a SignID reply for a DoCommand.
Definition: script_instance.cpp:278
CommandCost
Common return value for all commands.
Definition: command_type.h:23
ScriptInstance::in_shutdown
bool in_shutdown
Is this instance currently being destructed?
Definition: script_instance.hpp:295
ScriptInstance::InShutdown
bool InShutdown() const
Indicate whether this instance is currently being destroyed.
Definition: script_instance.hpp:245
ScriptInstance::DoCommandReturn
static void DoCommandReturn(ScriptInstance *instance)
Return a true/false reply for a DoCommand.
Definition: script_instance.cpp:268
ScriptInstance::SaveEmpty
static void SaveEmpty()
Don't save any data in the savegame.
Definition: script_instance.cpp:470
ScriptInstance::LoadObjects
static bool LoadObjects(ScriptData *data)
Load all objects from a savegame.
Definition: script_instance.cpp:565
ScriptInstance::Load
static ScriptData * Load(int version)
Load data from a savegame.
Definition: script_instance.cpp:673
ScriptInstance::IsDead
bool IsDead() const
Return the "this script died" value.
Definition: script_instance.hpp:153
CommandCallbackData
void CommandCallbackData(Commands cmd, const CommandCost &result, const CommandDataBuffer &data, CommandDataBuffer result_data)
Define a callback function for the client, after the command is finished.
Definition: command_type.h:495
ScriptInstance::SQSL_TABLE
@ SQSL_TABLE
The following data is an table.
Definition: script_instance.hpp:32
ScriptInstance::is_started
bool is_started
Is the scripts constructor executed?
Definition: script_instance.hpp:290
ScriptInstance::DoCommandReturnStoryPageID
static void DoCommandReturnStoryPageID(ScriptInstance *instance)
Return a StoryPageID reply for a DoCommand.
Definition: script_instance.cpp:293
ScriptInstance::RegisterAPI
virtual void RegisterAPI()
Register all API functions to the VM.
Definition: script_instance.cpp:114
ScriptInstance::LoadEmpty
static void LoadEmpty()
Load and discard data from a savegame.
Definition: script_instance.cpp:664
ScriptInstance::DoCommandReturnGroupID
static void DoCommandReturnGroupID(ScriptInstance *instance)
Return a GroupID reply for a DoCommand.
Definition: script_instance.cpp:283
ScriptInstance::IsSleeping
bool IsSleeping()
Check if the instance is sleeping, which either happened because the script executed a DoCommand,...
Definition: script_instance.hpp:238
ScriptInstance::FindLibrary
virtual class ScriptInfo * FindLibrary(const std::string &library, int version)=0
Find a library.
ScriptInstance::versionAPI
std::string versionAPI
Current API used by this script.
Definition: script_instance.hpp:255
ScriptInstance::LoadCompatibilityScripts
bool LoadCompatibilityScripts(const std::string &api_version, Subdirectory dir)
Load squirrel scripts to emulate an older API.
Definition: script_instance.cpp:119
ScriptInstance::callback
Script_SuspendCallbackProc * callback
Callback that should be called in the next tick the script runs.
Definition: script_instance.hpp:296
ScriptInstance::SQSL_ARRAY
@ SQSL_ARRAY
The following data is an array.
Definition: script_instance.hpp:31
ScriptInstance::DoCommandCallback
bool DoCommandCallback(const CommandCost &result, const CommandDataBuffer &data, CommandDataBuffer result_data, Commands cmd)
DoCommand callback function for all commands executed by scripts.
Definition: script_instance.cpp:754
ScriptInstance::SQSL_NULL
@ SQSL_NULL
A null variable.
Definition: script_instance.hpp:34
ScriptInstance::SQSL_BOOL
@ SQSL_BOOL
The following data is a boolean.
Definition: script_instance.hpp:33
ScriptInstance::GetSetting
virtual int GetSetting(const std::string &name)=0
Get the value of a setting of the current instance.
ScriptInstance::Initialize
void Initialize(const std::string &main_script, const std::string &instance_name, CompanyID company)
Initialize the script and prepare it for its first run.
Definition: script_instance.cpp:70
ScriptInstance::DoCommandReturnVehicleID
static void DoCommandReturnVehicleID(ScriptInstance *instance)
Return a VehicleID reply for a DoCommand.
Definition: script_instance.cpp:273
ScriptInstance::GetStorage
class ScriptStorage * GetStorage()
Get the storage of this script.
Definition: script_instance.cpp:314
ScriptInstance::GetController
class ScriptController * GetController()
Get the controller attached to the instance.
Definition: script_instance.hpp:148
ScriptInstance::LoadOnStack
void LoadOnStack(ScriptData *data)
Store loaded data on the stack.
Definition: script_instance.cpp:690
Subdirectory
Subdirectory
The different kinds of subdirectories OpenTTD uses.
Definition: fileio_type.h:108
ScriptInstance::SQSaveLoadType
SQSaveLoadType
The type of the data that follows in the savegame.
Definition: script_instance.hpp:28
ScriptInstance::Died
virtual void Died()
Tell the script it died.
Definition: script_instance.cpp:156
ScriptInstance::suspend
int suspend
The amount of ticks to suspend this script before it's allowed to continue.
Definition: script_instance.hpp:293
ScriptInstance::Continue
void Continue()
A script in multiplayer waits for the server to handle its DoCommand.
Definition: script_instance.cpp:150
ScriptInstance::SQSL_INT
@ SQSL_INT
The following data is an integer.
Definition: script_instance.hpp:29
ScriptInstance::IsPaused
bool IsPaused()
Checks if the script is paused.
Definition: script_instance.cpp:560
ScriptInstance::CollectGarbage
void CollectGarbage()
Let the VM collect any garbage.
Definition: script_instance.cpp:260
Commands
Commands
List of commands.
Definition: command_type.h:187
ScriptInfo
All static information from an Script like name, version, etc.
Definition: script_info.hpp:30
SQUIRREL_MAX_DEPTH
static const uint SQUIRREL_MAX_DEPTH
The maximum recursive depth for items stored in the savegame.
Definition: script_instance.hpp:22
ScriptInstance::GetDoCommandCallback
virtual CommandCallbackData * GetDoCommandCallback()=0
Get the callback handling DoCommands in case of networking.