feat: new global event OnSave

data/libs/functions/revscriptsys.lua

@@ -233,6 +233,10 @@ do
 			self:type("periodchange")
 			self:onPeriodChange(value)
 			return
+		elseif key == "onSave" then
+			self:type("save")
+			self:onSave(value)
+			return
 		end
 		rawset(self, key, value)
 	end

src/game/game.cpp

@@ -350,7 +350,8 @@ void Game::setGameState(GameState_t newState) {
 		}
 
 		case GAME_STATE_SHUTDOWN: {
-			g_globalEvents().execute(GLOBALEVENT_SHUTDOWN);
+			g_globalEvents().save();
+			g_globalEvents().shutdown();
 
 			// kick all players that are still online
 			auto it = players.begin();
@@ -368,6 +369,8 @@ void Game::setGameState(GameState_t newState) {
 		}
 
 		case GAME_STATE_CLOSED: {
+			g_globalEvents().save();
+
 			/* kick all players without the CanAlwaysLogin flag */
 			auto it = players.begin();
 			while (it != players.end()) {

src/lua/functions/core/game/global_functions.cpp

@@ -723,6 +723,7 @@
 }
 
 int GlobalFunctions::luaSaveServer(lua_State* L) {
+	g_globalEvents().save();
 	g_saveManager().scheduleAll();
 	pushBoolean(L, true);
 	return 1;

src/lua/functions/events/global_event_functions.cpp

@@ -40,6 +40,8 @@ int GlobalEventFunctions::luaGlobalEventType(lua_State* L) {
 			global->setEventType(GLOBALEVENT_PERIODCHANGE);
 		} else if (tmpStr == "onthink") {
 			global->setEventType(GLOBALEVENT_ON_THINK);
+		} else if (tmpStr == "save") {
+			global->setEventType(GLOBALEVENT_SAVE);
 		} else {
 			g_logger().error("[GlobalEventFunctions::luaGlobalEventType] - "
 							 "Invalid type for global event: {}");

src/lua/functions/events/global_event_functions.hpp

@@ -25,6 +25,7 @@ class GlobalEventFunctions final : LuaScriptInterface {
 		registerMethod(L, "GlobalEvent", "onShutdown", GlobalEventFunctions::luaGlobalEventOnCallback);
 		registerMethod(L, "GlobalEvent", "onRecord", GlobalEventFunctions::luaGlobalEventOnCallback);
 		registerMethod(L, "GlobalEvent", "onPeriodChange", GlobalEventFunctions::luaGlobalEventOnCallback);
+		registerMethod(L, "GlobalEvent", "onSave", GlobalEventFunctions::luaGlobalEventOnCallback);
 	}
 
 private:

src/lua/global/globalevent.cpp

@@ -64,6 +64,14 @@
 	execute(GLOBALEVENT_STARTUP);
 }
 
+void GlobalEvents::shutdown() const {
+	execute(GLOBALEVENT_SHUTDOWN);
+}
+
+void GlobalEvents::save() const {
+	execute(GLOBALEVENT_SAVE);
+}
+
 void GlobalEvents::timer() {
 	time_t now = time(nullptr);
 
@@ -159,7 +167,8 @@
 		case GLOBALEVENT_PERIODCHANGE:
 		case GLOBALEVENT_STARTUP:
 		case GLOBALEVENT_SHUTDOWN:
-		case GLOBALEVENT_RECORD: {
+		case GLOBALEVENT_RECORD:
+		case GLOBALEVENT_SAVE: {
 			GlobalEventMap retMap;
 			for (const auto &it : serverMap) {
 				if (it.second->getEventType() == type) {
@@ -190,6 +199,8 @@
 			return "onPeriodChange";
 		case GLOBALEVENT_ON_THINK:
 			return "onThink";
+		case GLOBALEVENT_ON_SAVE:
+			return "onSave";
 		default:
 			g_logger().error("[GlobalEvent::getScriptTypeName] - Invalid event type");
 			return std::string();

src/lua/global/globalevent.hpp

@@ -29,6 +29,8 @@ class GlobalEvents final : public Scripts {
 	}
 
 	void startup() const;
+	void shutdown() const;
+	void save() const;
 
 	void timer();
 	void think();

src/lua/lua_definitions.hpp

@@ -108,6 +108,7 @@ enum GlobalEvent_t {
 	GLOBALEVENT_RECORD,
 	GLOBALEVENT_PERIODCHANGE,
 	GLOBALEVENT_ON_THINK,
+	GLOBALEVENT_SAVE,
 };
 
 enum ModuleType_t {

src/server/signals.cpp

@@ -15,6 +15,7 @@
 #include "lib/thread/thread_pool.hpp"
 #include "lua/creature/events.hpp"
 #include "lua/scripts/lua_environment.hpp"
+#include "lua/global/globalevent.hpp"
 #include "server/signals.hpp"
 
 Signals::Signals(asio::io_service &service) :
@@ -92,6 +93,7 @@ void Signals::sigtermHandler() {
 void Signals::sigusr1Handler() {
 	// Dispatcher thread
 	g_logger().info("SIGUSR1 received, saving the game state...");
+	g_globalEvents().save();
 	g_saveManager().scheduleAll();
 }