feat：游戏结束事件施工中

Author: eee555

src/mineSweeperGUI.py

@@ -7,7 +7,7 @@
 # from PyQt5.QtWidgets import QApplication, QFileDialog, QWidget
 import gameDefinedParameter
 from plugin_sdk.server_bridge import GameServerBridge
-from shared_types.events import VideoSaveEvent, BoardUpdateEvent, GameStatusChangeEvent
+from shared_types.events import GameEndEvent, BoardUpdateEvent, GameStatusChangeEvent
 import superGUI
 import gameAbout
 import gameSettings
@@ -224,7 +224,7 @@ def game_state(self, game_state: str):
 
         match self._game_state:
             case "playing":
-                self.try_append_evfs(game_state)
+                self.onGameEnd(game_state)
                 if game_state not in ("playing", "show", "joking"):
                     self.timer_10ms.stop()
                     self.unlimit_cursor()
@@ -280,6 +280,7 @@ def game_state(self, game_state: str):
             GameServerBridge.instance().send_event(event)
         self._send_board_update_event()
 
+
     @property
     def row(self):
         return self._row
@@ -313,6 +314,65 @@ def minenum(self, minenum):
         })
         self._minenum = minenum
 
+
+    # 生命周期函数，正式的游戏结束时调用。由游戏状态的变更触发，当且仅当由playing变为其他状态
+    # 处理数据相关。不处理前端显示
+    def onGameEnd(self, new_game_state):
+        # 不论如何都必然生成数据
+        self.dump_evf_file_data()
+        # 发信号给插件，游戏结束了
+        event = GameEndEvent(
+            game_state = ['ready', 'study', 'show', 'playing', 'joking', 'fail', 
+                          'win', 'jofail', 'jowin', 'display', 'showdisplay'].index(new_game_state),
+            nf = self.label.ms_board.rce == 0,
+            row = self.label.ms_board.row,
+            column = self.label.ms_board.column,
+            mine_num = self.label.ms_board.mine_num,
+            rtime = self.label.ms_board.rtime,
+            left = self.label.ms_board.left,
+            right = self.label.ms_board.right,
+            double = self.label.ms_board.double,
+            # 游戏难度（级别）。3是初级；4是中级；5是高级；6是自定义。
+            level = self.label.ms_board.level,
+            cl = self.label.ms_board.cl,
+            ce = self.label.ms_board.ce,
+            rce = self.label.ms_board.rce,
+            lce = self.label.ms_board.lce,
+            dce = self.label.ms_board.dce,
+            bbbv = self.label.ms_board.bbbv,
+            bbbv_solved = self.label.ms_board.bbbv_solved,
+            zini = self.label.ms_board.zini,
+            flag = self.label.ms_board.flag,
+            path = self.label.ms_board.path,
+            start_time = self.label.ms_board.start_time,
+            end_time = self.label.ms_board.end_time,
+            mode = self.label.ms_board.mode,
+            software = self.label.ms_board.software,
+            player_identifier = self.label.ms_board.player_identifier,
+            race_identifier = self.label.ms_board.race_identifier,
+            uniqueness_identifier = self.label.ms_board.uniqueness_identifier,
+            is_official = self.label.ms_board.is_official,
+            is_fair = self.label.ms_board.is_fair,
+            op = self.label.ms_board.op,
+            isl = self.label.ms_board.isl,
+            pluck = self.label.ms_board.pluck,
+            board = self.label.ms_board.board,
+            raw_data = self.label.ms_board.raw_data
+        )
+        GameServerBridge.instance().send_event(event)
+
+        # 强制保存Metasweeper.dat文件
+        ...
+
+
+
+        # 根据策略保存录像文件到磁盘
+        if self.autosave_video and self.checksum_module_ok() and\
+              new_game_state in "win":
+            self.save_evf_file()
+        self.try_append_evfs(new_game_state)
+
+
     def layMine(self, i, j):
 
         xx = self.row
@@ -629,24 +689,24 @@ def gameFinished(self):
         self.score_board_manager.show(self.label.ms_board, index_type=2)
         self.enable_screenshot()
         self.unlimit_cursor()
-        ms_board = self.label.ms_board
-        status = utils.GameBoardState(ms_board.game_board_state)
-        if status == utils.GameBoardState.Win:
-            self.dump_evf_file_data()
-            event = VideoSaveEvent()
-            data = msgspec.structs.asdict(event)
-            for key in data:
-                if hasattr(ms_board, key):
-                    if key == "raw_data":
-                        data[key] = base64.b64encode(
-                            ms_board.raw_data).decode("utf-8")
-                        continue
-                    data[key] = getattr(ms_board, key)
-            event = VideoSaveEvent(**data)
-            GameServerBridge.instance().send_event(event)
+        # ms_board = self.label.ms_board
+        # status = utils.GameBoardState(ms_board.game_board_state)
+        # if status == utils.GameBoardState.Win:
+        #     self.dump_evf_file_data()
+            # event = VideoSaveEvent()
+            # data = msgspec.structs.asdict(event)
+            # for key in data:
+            #     if hasattr(ms_board, key):
+            #         if key == "raw_data":
+            #             data[key] = base64.b64encode(
+            #                 ms_board.raw_data).decode("utf-8")
+            #             continue
+            #         data[key] = getattr(ms_board, key)
+            # event = VideoSaveEvent(**data)
+            # GameServerBridge.instance().send_event(event)
 
         # 发送棋盘更新事件，让插件知道最终状态
-        self._send_board_update_event()
+        # self._send_board_update_event()
 
     def gameWin(self):  # 成功后改脸和状态变量，停时间
         self.timer_10ms.stop()
@@ -660,9 +720,9 @@ def gameWin(self):  # 成功后改脸和状态变量，停时间
             raise RuntimeError
         self.set_face(17)
 
-        if self.autosave_video and self.checksum_module_ok():
-            self.dump_evf_file_data()
-            self.save_evf_file()
+        # if self.autosave_video and self.checksum_module_ok():
+        #     self.dump_evf_file_data()
+        #     self.save_evf_file()
 
         self.gameFinished()
 
@@ -736,11 +796,17 @@ def dump_evf_file_data(self):
     # 将evf数据存成evf文件
     # 调试的时候不会自动存录像，见checksum_module_ok
     # 菜单保存的回调。以及游戏结束自动保存。
-    def save_evf_file(self):
+    # 返回保存的文件绝对路径
+    def save_evf_file(self) -> str:
         if not os.path.exists(self.replay_path):
             os.mkdir(self.replay_path)
 
-        self.label.ms_board.save_to_evf_file(self.cal_evf_filename())
+        file_name = self.cal_evf_filename()
+        # 加上后缀和重复标识数字
+        real_file_name = self.label.ms_board.save_to_evf_file(file_name)
+        absolute_path = os.path.abspath(os.path.join(self.replay_path, real_file_name))
+        return absolute_path
+
 
     # 拼接evf录像的文件名，无后缀
     def cal_evf_filename(self, absolute=True) -> str:

src/shared_types/events.py

@@ -58,53 +58,59 @@ class ButtonClickEvent(BaseEvent, tag="button_click"):
     button = 0
 
 
-class VideoSaveEvent(BaseEvent, tag="video_save"):
-    """录像保存事件"""
+class GameEndEvent(BaseEvent, tag="game_end"):
+    """
+    游戏结束事件。发生在游戏胜利、失败、重开、游戏关闭、游戏设置关闭、切换游戏状态关闭、
+    游戏状态变为非正式等情况。
+    playing状态切换为其他状态时触发此消息。自定义难度、各种模式均会触发。
+    """
 
-    game_board_state: int = 0
-    rtime: float = 0
+    # 游戏的新状态（旧状态必为playing），'ready'、'study'、'show'、'playing'、'joking'、
+    # 'fail'、'win'、'jofail'、'jowin'、'display'、'showdisplay'分别记作0-10
+    game_state: int = 0
+    # False-flag, True-nf
+    nf: bool = False
+    row: int = 16
+    column: int = 30
+    mine_num: int = 99
+    rtime: float = 0.0
     left: int = 126
     right: int = 11
     double: int = 14
-    left_s: float = 2.5583756345177666
-    right_s: float = 0.2233502538071066
-    double_s: float = 0.28426395939086296
+    # 游戏难度（级别）。3是初级；4是中级；5是高级；6是自定义。
     level: int = 5
     cl: int = 151
-    cl_s: float = 3.065989847715736
     ce: int = 144
-    ce_s: float = 2.9238578680203045
     rce: int = 11
     lce: int = 119
     dce: int = 14
     bbbv: int = 127
     bbbv_solved: int = 127
-    bbbv_s: float = 2.5786802030456855
+    zini: int = 105
     flag: int = 11
     path: float = 6082.352554578606
-    etime: float = 1666124184868000
+    # 时间戳，微秒
     start_time: int = 1666124135606000
     end_time: int = 1666124184868000
+    # 标准0、win74、经典无猜5、强无猜6、弱无猜7、准无猜8、强可猜9、弱可猜10
     mode: int = 0
-    software: str = "Arbiter"
-    player_identifier: str = "Wang Jianing G01825"
-    race_identifier: str = ""
+    software: str = "元 3.2.2"
+    player_identifier: str = "Wang Jianing"
+    race_identifier: str = "G1234"
     uniqueness_identifier: str = ""
-    stnb: float = 0
-    corr: float = 0
-    thrp: float = 0
-    ioe: float = 0
     is_official: bool = False
     is_fair: bool = False
     op: int = 0
     isl: int = 0
     pluck: float = 0
-    raw_data: str = ""
+    board: List[List[int]] = []
+    # evf4版本的二进制数据
+    raw_data: bytes = b""
 
 
 EVENT_TYPES = [
     BoardUpdateEvent,
     GameStatusChangeEvent,
     ButtonClickEvent,
-    VideoSaveEvent,
+    GameEndEvent,
 ]

src/superGUI.py

@@ -509,6 +509,7 @@ def read_or_create_game_setting(self):
         self.race_identifier = self.game_setting.get_or_set_value("DEFAULT/race_identifier", "", str)
         self.unique_identifier = self.game_setting.get_or_set_value("DEFAULT/unique_identifier", "", str)
         self.country = self.game_setting.get_or_set_value("DEFAULT/country", "", str)
+        # 是否自动保存录像。开启时，自动保存所有扫完的、正式的录像。假如要其他保存策略，应使用插件来完成。
         self.autosave_video = self.game_setting.get_or_set_value("DEFAULT/autosave_video", True, bool)
         self.autosave_video_set = self.game_setting.get_or_set_value("DEFAULT/autosave_video_set", False, bool)
         self.filter_forever = self.game_setting.get_or_set_value("DEFAULT/filter_forever", False, bool)