From bf699e4f2cae7c2dd946975b43abab90bf722b99 Mon Sep 17 00:00:00 2001
From: EggLink <146359339+EggLink@users.noreply.github.com>
Date: Sun, 30 Jun 2024 15:06:21 +0800
Subject: [PATCH] Write a readme for mission part

---
 GameServer/Game/Mission/README.md | 47 +++++++++++++++++++++++++++++++
 1 file changed, 47 insertions(+)
 create mode 100644 GameServer/Game/Mission/README.md

diff --git a/GameServer/Game/Mission/README.md b/GameServer/Game/Mission/README.md
new file mode 100644
index 00000000..e397f7c6
--- /dev/null
+++ b/GameServer/Game/Mission/README.md
@@ -0,0 +1,47 @@
+# Mission Part
+## Menu
+- [MissionManager](#missionmanager)
+- [FinishTypeHandler](#finishtypehandler)
+- [FinishActionHandler](#finishactionhandler)
+
+## MissionManager
+- `MissionManager.cs`: Used to manage the player's mission data
+
+### Method
+- (need to write)
+
+
+## FinishTypeHandler
+
+Class Name Style: **MissionHandler<Type>**  
+Example:
+```
+[MissionFinishType(MissionFinishTypeEnum.<Type>)]
+public class MissionHandler<Type> : MissionFinishTypeHandler
+{
+    public override void Init(PlayerInstance player, SubMissionInfo info, object? arg)
+    {
+        // your code
+    } 
+
+    public override void HandleFinishType(PlayerInstance player, SubMissionInfo info, object? arg)
+    {
+        // your code
+    }
+}
+```
+
+## FinishActionHandler
+
+Class Name Style: **MissionHandler<Type>**  
+Example:
+```
+[MissionFinishAction(FinishActionTypeEnum.<Type>)]
+public class MissionHandler<Type> : MissionFinishActionHandler
+{
+    public override void OnHandle(List<int> Params, List<string> ParamString, PlayerInstance Player)
+    {
+        // your code
+    }
+}
+```