OpenTTD Source
20240917-master-g9ab0a47812
|
Go to the documentation of this file.
10 #include "../stdafx.h"
12 #include "../saveload/saveload.h"
14 #include "../script/squirrel_class.hpp"
15 #include "../script/squirrel_std.hpp"
22 #include "api/script_controller.hpp"
23 #include "api/script_error.hpp"
24 #include "api/script_event.hpp"
25 #include "api/script_log.hpp"
27 #include "../company_base.h"
28 #include "../company_func.h"
29 #include "../fileio_func.h"
30 #include "../league_type.h"
31 #include "../misc/endian_buffer.hpp"
33 #include "../safeguards.h"
35 ScriptStorage::~ScriptStorage()
38 if (
event_data !=
nullptr) ScriptEventController::FreeEventPointer();
46 static void PrintFunc(
bool error_msg,
const std::string &message)
49 ScriptController::Print(error_msg, message);
59 is_save_data_on_stack(false),
72 ScriptObject::ActiveInstance active(
this);
74 this->
controller =
new ScriptController(company);
85 ScriptObject::SetAllowDoCommand(
false);
89 }
else if (!this->
engine->
LoadScript(main_script) || this->engine->IsSuspended()) {
90 if (this->
engine->
IsSuspended()) ScriptLog::Error(
"This script took too long to load script. AI is not started.");
105 ScriptObject::SetAllowDoCommand(
true);
121 std::string script_name = fmt::format(
"compat_{}.nut", api_version);
123 std::string buf = FioGetDirectory(sp, dir);
129 ScriptLog::Error(
"Failed to load API compatibility script");
130 Debug(script, 0,
"Error compiling / running API compatibility script: {}", buf);
134 ScriptLog::Warning(
"API compatibility script not found");
138 ScriptInstance::~ScriptInstance()
140 ScriptObject::ActiveInstance active(
this);
158 Debug(script, 0,
"The script died unexpectedly.");
173 ScriptObject::ActiveInstance active(
this);
175 if (this->
IsDead())
return;
186 if (--this->
suspend > 0)
return;
211 ScriptObject::SetAllowDoCommand(
false);
215 if (this->
engine->
IsSuspended()) ScriptLog::Error(
"This script took too long to initialize. Script is not started.");
221 if (this->
engine->
IsSuspended()) ScriptLog::Error(
"This script took too long in the Load function. Script is not started.");
225 ScriptObject::SetAllowDoCommand(
true);
263 ScriptObject::ActiveInstance active(
this);
270 instance->engine->InsertResult(ScriptObject::GetLastCommandRes());
275 instance->engine->InsertResult(EndianBufferReader::ToValue<VehicleID>(ScriptObject::GetLastCommandResData()));
280 instance->engine->InsertResult(EndianBufferReader::ToValue<SignID>(ScriptObject::GetLastCommandResData()));
285 instance->engine->InsertResult(EndianBufferReader::ToValue<GroupID>(ScriptObject::GetLastCommandResData()));
290 instance->engine->InsertResult(EndianBufferReader::ToValue<GoalID>(ScriptObject::GetLastCommandResData()));
295 instance->engine->InsertResult(EndianBufferReader::ToValue<StoryPageID>(ScriptObject::GetLastCommandResData()));
300 instance->engine->InsertResult(EndianBufferReader::ToValue<StoryPageElementID>(ScriptObject::GetLastCommandResData()));
305 instance->engine->InsertResult(EndianBufferReader::ToValue<LeagueTableElementID>(ScriptObject::GetLastCommandResData()));
310 instance->engine->InsertResult(EndianBufferReader::ToValue<LeagueTableID>(ScriptObject::GetLastCommandResData()));
321 ScriptObject::ActiveInstance active(
this);
323 return ScriptObject::GetLogData();
356 if (max_depth == 0) {
357 ScriptLog::Error(
"Savedata can only be nested to 25 deep. No data saved.");
361 switch (sq_gettype(vm, index)) {
368 sq_getinteger(vm, index, &res);
370 int64_t value = (int64_t)res;
371 SlCopy(&value, 1, SLE_INT64);
382 sq_getstring(vm, index, &buf);
383 size_t len = strlen(buf) + 1;
385 ScriptLog::Error(
"Maximum string length is 254 chars. No data saved.");
391 SlCopy(
const_cast<char *
>(buf), len, SLE_CHAR);
402 while (SQ_SUCCEEDED(sq_next(vm, index - 1))) {
404 bool res =
SaveObject(vm, -1, max_depth - 1, test);
425 while (SQ_SUCCEEDED(sq_next(vm, index - 1))) {
448 sq_getbool(vm, index, &res);
465 ScriptLog::Error(
"You tried to save an unsupported type. No data saved.");
478 ScriptObject::ActiveInstance active(
this);
498 bool backup_allow = ScriptObject::GetAllowDoCommand();
499 ScriptObject::SetAllowDoCommand(
false);
521 ScriptObject::SetAllowDoCommand(backup_allow);
523 if (!sq_istable(savedata)) {
524 ScriptLog::Error(this->
engine->
IsSuspended() ?
"This script took too long to Save." :
"Save function should return a table.");
529 sq_pushobject(vm, savedata);
540 ScriptLog::Warning(
"Save function is not implemented");
572 if (data !=
nullptr) data->push_back((SQInteger)value);
578 static char buf[std::numeric_limits<decltype(
_script_sl_byte)>::max()];
613 ScriptDataVariant value = data->front();
616 if (std::holds_alternative<SQInteger>(value)) {
617 sq_pushinteger(vm, std::get<SQInteger>(value));
621 if (std::holds_alternative<std::string>(value)) {
622 sq_pushstring(vm, std::get<std::string>(value), -1);
626 if (std::holds_alternative<SQBool>(value)) {
627 sq_pushbool(vm, std::get<SQBool>(value));
631 switch (std::get<SQSaveLoadType>(value)) {
635 sq_arrayappend(vm, -2);
660 default: NOT_REACHED();
684 ScriptData *data =
new ScriptData();
685 data->push_back((SQInteger)version);
692 ScriptObject::ActiveInstance active(
this);
694 if (this->
IsDead() || data ==
nullptr)
return;
698 ScriptDataVariant version = data->front();
700 SQInteger top = sq_gettop(vm);
702 sq_pushinteger(vm, std::get<SQInteger>(version));
706 ScriptLog::Warning(fmt::format(
"Loading failed: {}", e.
GetErrorMessage()));
721 ScriptLog::Warning(
"Loading failed: there was data for the script to load, but the script does not have a Load() function.");
731 sq_pushstring(vm,
"Load", -1);
742 if (SQ_FAILED(sq_call(vm, 3, SQFalse, SQFalse,
MAX_SL_OPS)))
return false;
756 ScriptObject::ActiveInstance active(
this);
758 if (!ScriptObject::CheckLastCommand(data, cmd)) {
759 Debug(script, 1,
"DoCommandCallback terminating a script, last command does not match expected command");
763 ScriptObject::SetLastCommandRes(result.
Succeeded());
764 ScriptObject::SetLastCommandResData(std::move(result_data));
767 ScriptObject::SetLastError(ScriptError::StringToError(result.
GetErrorMessage()));
769 ScriptObject::IncreaseDoCommandCosts(result.
GetCost());
770 ScriptObject::SetLastCost(result.
GetCost());
773 ScriptObject::SetLastCommand({},
CMD_END);
780 ScriptObject::ActiveInstance active(
this);
782 ScriptEventController::InsertEvent(event);
785 size_t ScriptInstance::GetAllocatedMemory()
const
@ SQSL_ARRAY_TABLE_END
Marks the end of an array or table, no data follows.
virtual void LoadDummyScript()=0
Load the dummy script.
A throw-class that is given when the script wants to suspend.
static bool SaveObject(HSQUIRRELVM vm, SQInteger index, int max_depth, bool test)
Save one object (int / string / array / table) to the savegame.
class Squirrel * engine
A wrapper around the squirrel vm.
size_t last_allocated_memory
Last known allocated memory value (for display for crashed scripts)
The storage for each script.
bool CallLoad()
Call the script Load function if it exists and data was loaded from a savegame.
bool is_dead
True if the script has been stopped.
void InsertEvent(class ScriptEvent *event)
Insert an event for this script.
void GameLoop()
Run the GameLoop of a script.
void SetPrintFunction(SQPrintFunc *func)
Set a custom print function, so you can handle outputs from SQ yourself.
int GetSuspendTime()
Get the amount of ticks the script should be suspended.
class ScriptController * controller
The script main class.
void Save()
Call the script Save function and save all data in the savegame.
class Squirrel * engine
The engine we're scanning with.
void SlCopy(void *object, size_t length, VarType conv)
Copy a list of SL_VARs to/from a savegame.
Runtime information about a script like a pointer to the squirrel vm and the current state.
ScriptInstance(const char *APIName)
Create a new script.
void Unpause()
Resume execution of the script.
Owner
Enum for all companies/owners.
static void DoCommandReturnStoryPageElementID(ScriptInstance *instance)
Return a StoryPageElementID reply for a DoCommand.
void SlErrorCorrupt(const std::string &msg)
Error handler for corrupt savegames.
Searchpath
Types of searchpaths OpenTTD might use.
SQObject * instance
Squirrel-pointer to the script main class.
static void StrMakeValid(T &dst, const char *str, const char *last, StringValidationSettings settings)
Copies the valid (UTF-8) characters from str up to last to the dst.
@ SQSL_STRING
The following data is an string.
bool is_save_data_on_stack
Is the save data still on the squirrel stack?
HSQUIRRELVM GetVM()
Get the squirrel VM.
bool is_paused
Is the script paused? (a paused script will not be executed until unpaused)
ScriptLogTypes::LogData & GetLogData()
Get the log pointer of this script.
static void DoCommandReturnLeagueTableElementID(ScriptInstance *instance)
Return a LeagueTableElementID reply for a DoCommand.
const std::string & GetErrorMessage() const
The error message associated with the fatal error.
static void DoCommandReturnLeagueTableID(ScriptInstance *instance)
Return a LeagueTableID reply for a DoCommand.
StringID GetErrorMessage() const
Returns the error message of a command.
#define Debug(category, level, format_string,...)
Ouptut a line of debugging information.
bool Succeeded() const
Did this command succeed?
SQInteger GetOpsTillSuspend()
Get the number of operations the script can execute before being suspended.
void Pause()
Suspends the script for the current tick and then pause the execution of script.
static void DoCommandReturnGoalID(ScriptInstance *instance)
Return a GoalID reply for a DoCommand.
void ReleaseSQObject(HSQOBJECT *obj)
Decrease the ref count of a squirrel object.
class ScriptStorage * storage
Some global information for each running script.
SQInteger GetOpsTillSuspend()
How many operations can we execute till suspension?
bool HasScriptCrashed()
Find out if the squirrel script made an error before.
static void DoCommandReturnSignID(ScriptInstance *instance)
Return a SignID reply for a DoCommand.
Common return value for all commands.
bool in_shutdown
Is this instance currently being destructed?
static const SaveLoad _script_byte[]
SaveLoad array that saves/loads exactly one byte.
ScriptSettings script
settings for scripts
static void DoCommandReturn(ScriptInstance *instance)
Return a true/false reply for a DoCommand.
static void SaveEmpty()
Don't save any data in the savegame.
static bool LoadObjects(ScriptData *data)
Load all objects from a savegame.
bool FileExists(const std::string &filename)
Test whether the given filename exists.
static ScriptData * Load(int version)
Load data from a savegame.
#define SLEG_VAR(name, variable, type)
Storage of a global variable in every savegame version.
void SetGlobalPointer(void *ptr)
Sets a pointer in the VM that is reachable from where ever you are in SQ.
bool Failed() const
Did this command fail?
static void PrintFunc(bool error_msg, const std::string &message)
Callback called by squirrel when a script uses "print" and for error messages.
bool IsDead() const
Return the "this script died" value.
void * event_data
Pointer to the event data storage.
size_t GetAllocatedMemory() const noexcept
Get number of bytes allocated by this VM.
std::vector< uint8_t > CommandDataBuffer
Storage buffer for serialized command data.
GameSettings _settings_game
Game settings of a running game or the scenario editor.
@ SQSL_TABLE
The following data is an table.
Money GetCost() const
The costs as made up to this moment.
bool is_started
Is the scripts constructor executed?
static uint8_t _script_sl_byte
Used as source/target by the script saveload code to store/load a single byte.
void ThrowError(const std::string_view error)
Throw a Squirrel error that will be nicely displayed to the user.
static void DoCommandReturnStoryPageID(ScriptInstance *instance)
Return a StoryPageID reply for a DoCommand.
virtual void RegisterAPI()
Register all API functions to the VM.
bool CallMethod(HSQOBJECT instance, const char *method_name, HSQOBJECT *ret, int suspend)
Call a method of an instance, in various flavors.
std::string main_script
The full path of the script.
static void LoadEmpty()
Load and discard data from a savegame.
static void DoCommandReturnGroupID(ScriptInstance *instance)
Return a GroupID reply for a DoCommand.
Script_SuspendCallbackProc * GetSuspendCallback()
Get the callback to call when the script can run again.
void squirrel_register_std(Squirrel *engine)
Register all standard functions we want to give to a script.
void ResumeError()
Resume the VM with an error so it prints a stack trace.
bool LoadScript(const std::string &script)
Load a script.
CompanyID _current_company
Company currently doing an action.
bool LoadCompatibilityScripts(const std::string &api_version, Subdirectory dir)
Load squirrel scripts to emulate an older API.
static const int MAX_CONSTRUCTOR_OPS
The maximum number of operations for initial start of a script.
void CollectGarbage()
Tell the VM to do a garbage collection run.
Script_SuspendCallbackProc * callback
Callback that should be called in the next tick the script runs.
bool MethodExists(HSQOBJECT instance, const char *method_name)
Check if a method exists in an instance.
@ SLV_SCRIPT_INT64
296 PR#9415 SQInteger is 64bit but was saved as 32bit.
@ CMD_END
Must ALWAYS be on the end of this list!! (period)
@ SQSL_ARRAY
The following data is an array.
bool DoCommandCallback(const CommandCost &result, const CommandDataBuffer &data, CommandDataBuffer result_data, Commands cmd)
DoCommand callback function for all commands executed by scripts.
void CrashOccurred()
Set the script status to crashed.
@ SQSL_NULL
A null variable.
@ SQSL_BOOL
The following data is a boolean.
void Initialize(const std::string &main_script, const std::string &instance_name, CompanyID company)
Initialize the script and prepare it for its first run.
static void DoCommandReturnVehicleID(ScriptInstance *instance)
Return a VehicleID reply for a DoCommand.
class ScriptStorage * GetStorage()
Get the storage of this script.
void LoadOnStack(ScriptData *data)
Store loaded data on the stack.
SQSaveLoadType
The type of the data that follows in the savegame.
Subdirectory
The different kinds of subdirectories OpenTTD uses.
virtual void Died()
Tell the script it died.
int suspend
The amount of ticks to suspend this script before it's allowed to continue.
bool Resume(int suspend=-1)
Resume a VM when it was suspended via a throw.
A throw-class that is given when the script made a fatal error.
void Continue()
A script in multiplayer waits for the server to handle its DoCommand.
void ReleaseObject(HSQOBJECT *ptr)
Release a SQ object.
@ SQSL_INT
The following data is an integer.
bool IsPaused()
Checks if the script is paused.
bool IsSuspended()
Did the squirrel code suspend or return normally.
void CollectGarbage()
Let the VM collect any garbage.
Commands
List of commands.
void SlObject(void *object, const SaveLoadTable &slt)
Main SaveLoad function.
bool IsSavegameVersionBefore(SaveLoadVersion major, uint8_t minor=0)
Checks whether the savegame is below major.
uint32_t script_max_opcode_till_suspend
max opcode calls till scripts will suspend
static void DecreaseOps(HSQUIRRELVM vm, int amount)
Tell the VM to remove amount ops from the number of ops till suspend.
bool CreateClassInstance(const std::string &class_name, void *real_instance, HSQOBJECT *instance)
Exactly the same as CreateClassInstanceVM, only callable without instance of Squirrel.
static const uint SQUIRREL_MAX_DEPTH
The maximum recursive depth for items stored in the savegame.
static const int MAX_SL_OPS
The maximum number of operations for saving or loading the data of a script.