diff options
| -rw-r--r-- | src/script/api/ai/ai_controller.hpp.sq | 1 | ||||
| -rw-r--r-- | src/script/api/game/game_controller.hpp.sq | 1 | ||||
| -rw-r--r-- | src/script/api/script_controller.cpp | 24 | ||||
| -rw-r--r-- | src/script/api/script_controller.hpp | 12 |
4 files changed, 38 insertions, 0 deletions
diff --git a/src/script/api/ai/ai_controller.hpp.sq b/src/script/api/ai/ai_controller.hpp.sq index 57f8e7b60..2aefdd68e 100644 --- a/src/script/api/ai/ai_controller.hpp.sq +++ b/src/script/api/ai/ai_controller.hpp.sq @@ -20,6 +20,7 @@ void SQAIController_Register(Squirrel *engine) SQAIController.DefSQStaticMethod(engine, &ScriptController::GetOpsTillSuspend, "GetOpsTillSuspend", 1, "."); SQAIController.DefSQStaticMethod(engine, &ScriptController::SetCommandDelay, "SetCommandDelay", 2, ".i"); SQAIController.DefSQStaticMethod(engine, &ScriptController::Sleep, "Sleep", 2, ".i"); + SQAIController.DefSQStaticMethod(engine, &ScriptController::Break, "Break", 2, ".s"); SQAIController.DefSQStaticMethod(engine, &ScriptController::GetSetting, "GetSetting", 2, ".s"); SQAIController.DefSQStaticMethod(engine, &ScriptController::GetVersion, "GetVersion", 1, "."); SQAIController.DefSQStaticMethod(engine, &ScriptController::Print, "Print", 3, ".bs"); diff --git a/src/script/api/game/game_controller.hpp.sq b/src/script/api/game/game_controller.hpp.sq index 461ba52f4..7cae77de3 100644 --- a/src/script/api/game/game_controller.hpp.sq +++ b/src/script/api/game/game_controller.hpp.sq @@ -20,6 +20,7 @@ void SQGSController_Register(Squirrel *engine) SQGSController.DefSQStaticMethod(engine, &ScriptController::GetOpsTillSuspend, "GetOpsTillSuspend", 1, "."); SQGSController.DefSQStaticMethod(engine, &ScriptController::SetCommandDelay, "SetCommandDelay", 2, ".i"); SQGSController.DefSQStaticMethod(engine, &ScriptController::Sleep, "Sleep", 2, ".i"); + SQGSController.DefSQStaticMethod(engine, &ScriptController::Break, "Break", 2, ".s"); SQGSController.DefSQStaticMethod(engine, &ScriptController::GetSetting, "GetSetting", 2, ".s"); SQGSController.DefSQStaticMethod(engine, &ScriptController::GetVersion, "GetVersion", 1, "."); SQGSController.DefSQStaticMethod(engine, &ScriptController::Print, "Print", 3, ".bs"); diff --git a/src/script/api/script_controller.cpp b/src/script/api/script_controller.cpp index 1a53ab7c5..53ada04a6 100644 --- a/src/script/api/script_controller.cpp +++ b/src/script/api/script_controller.cpp @@ -15,10 +15,14 @@ #include "../../rev.h" #include "script_controller.hpp" +#include "script_error.hpp" #include "../script_fatalerror.hpp" #include "../script_info.hpp" #include "../script_instance.hpp" #include "script_log.hpp" +#include "../../ai/ai_gui.hpp" +#include "../../settings_type.h" +#include "../../network/network.h" /* static */ void ScriptController::SetCommandDelay(int ticks) { @@ -40,6 +44,26 @@ throw Script_Suspend(ticks, NULL); } +/* static */ bool ScriptController::Break(const char* message) +{ +#ifdef ENABLE_NETWORK + if (!_network_dedicated) return false; +#endif + if (!_settings_client.gui.ai_developer_tools) return false; + + ScriptObject::GetActiveInstance()->Pause(); + + char log_message[1024]; + snprintf(log_message, sizeof(log_message), "Break: %s", message); + ScriptLog::Log(ScriptLog::LOG_SQ_ERROR, log_message); + + /* Inform script developer that his script has been paused and + * needs manual action to continue. */ + ShowAIDebugWindow(ScriptObject::GetRootCompany()); + + return true; +} + /* static */ void ScriptController::Print(bool error_msg, const char *message) { ScriptLog::Log(error_msg ? ScriptLog::LOG_SQ_ERROR : ScriptLog::LOG_SQ_INFO, message); diff --git a/src/script/api/script_controller.hpp b/src/script/api/script_controller.hpp index 981ad50bb..9ee329124 100644 --- a/src/script/api/script_controller.hpp +++ b/src/script/api/script_controller.hpp @@ -105,6 +105,18 @@ public: static void Sleep(int ticks); /** + * Break execution of the script when script developer tools are active. For + * other users, nothing will happen when you call this function. To resume + * the script, you have to click on the continue button in the AI debug + * window. It is not recommended to leave calls to this function in scripts + * that you publish or upload to bananas. + * @param message to print in the AI debug window when the break occurs. + * @note gui.ai_developer_tools setting must be enabled or the break is + * ignored. + */ + static bool Break(const char* message); + + /** * When Squirrel triggers a print, this function is called. * Squirrel calls this when 'print' is used, or when the script made an error. * @param error_msg If true, it is a Squirrel error message. |