Merge pull request #110 from nowsprinting/feature/mppm

Support Multiplayer Play Mode (MPPM) package
DeNA · Nov 19, 2024 · bc14d37 · bc14d37
2 parents 6a913f2 + 25e6a8e
commit bc14d37
Show file tree

Hide file tree

Showing 7 changed files with 50 additions and 5 deletions.
diff --git a/Editor/UI/Settings/AutopilotSettingsEditor.cs b/Editor/UI/Settings/AutopilotSettingsEditor.cs
@@ -145,6 +145,7 @@ internal void Launch()
             else
             {
                 state.launchFrom = LaunchType.EditMode;
+                AssetDatabase.SaveAssetIfDirty(state); // Note: Sync with virtual players of MPPM package
                 EditorApplication.isPlaying = true;
             }
         }

diff --git a/README.md b/README.md
@@ -516,6 +516,7 @@ The placeholders you can include in the lead and message body template are:
 - "{message}": Message with terminate (e.g., error log message)
 - "{settings}": Name of running AutopilotSettings
 - "{env.KEY}": Environment variables
+- "{mppm-tags}": Tags of the [Multiplayer Play Mode](https://docs.unity3d.com/Packages/com.unity.multiplayer.playmode@latest) package
 
 
 

diff --git a/README_ja.md b/README_ja.md
@@ -521,6 +521,7 @@ Slack Botには次の権限が必要です。
 - "{message}": 終了要因メッセージ（エラーログのメッセージなど）
 - "{settings}": 実行中の AutopilotSettings 名
 - "{env.KEY}": 環境変数
+- "{mppm-tags}": [Multiplayer Play Mode](https://docs.unity3d.com/Packages/com.unity.multiplayer.playmode@latest) パッケージのタグ
 
 
 

diff --git a/Runtime/DeNA.Anjin.asmdef b/Runtime/DeNA.Anjin.asmdef
@@ -4,6 +4,7 @@
     "references": [
         "DeNA.Anjin.Annotations",
         "Unity.AutomatedQA",
+        "Unity.Multiplayer.Playmode",
         "UniTask",
         "TestHelper.Monkey",
         "TestHelper.Monkey.Annotations",
@@ -19,6 +20,12 @@
     "defineConstraints": [
         "UNITY_INCLUDE_TESTS || DENA_AUTOPILOT_ENABLE"
     ],
-    "versionDefines": [],
+    "versionDefines": [
+        {
+            "name": "com.unity.multiplayer.playmode",
+            "expression": "",
+            "define": "ENABLED_MPPM"
+        }
+    ],
     "noEngineReferences": false
 }
diff --git a/Runtime/Launcher.cs b/Runtime/Launcher.cs
@@ -224,6 +224,9 @@ internal static async UniTaskVoid TeardownLaunchAutopilotAsync(AutopilotState st
         {
             state.settings = null;
             state.exitCode = exitCode;
+#if UNITY_EDITOR
+            AssetDatabase.SaveAssetIfDirty(state); // Note: Sync with virtual players of MPPM package
+#endif
 
             if (state.launchFrom == LaunchType.PlayMode) // Note: Editor play mode, Play mode tests, and Player build
             {

diff --git a/Runtime/Reporters/MessageBuilder.cs b/Runtime/Reporters/MessageBuilder.cs
@@ -4,7 +4,11 @@
 using System;
 using System.Collections.Generic;
 using System.Linq;
+using System.Text;
 using DeNA.Anjin.Settings;
+#if ENABLED_MPPM
+using Unity.Multiplayer.Playmode;
+#endif
 
 namespace DeNA.Anjin.Reporters
 {
@@ -21,6 +25,7 @@ public static class MessageBuilder
         ///     - {message}: Message with terminate (e.g., error log message)
         ///     - {settings}: Name of running AutopilotSettings
         ///     - {env.KEY}: Environment variables
+        ///     - {mppm-tags}: Tags of the Multiplayer Play Mode package
         /// </param>
         /// <param name="message">Replace placeholder "{message}" in the template with this string</param>
         /// <returns>Messages that replaced placeholders in the template</returns>
@@ -30,6 +35,9 @@ public static string BuildWithTemplate(string template, string message = null)
             var placeholders = GetPlaceholders().ToList();
             placeholders.Add(("{message}", message));
             placeholders.Add(("{settings}", settings ? settings.Name : "null"));
+#if ENABLED_MPPM
+            placeholders.Add(("{mppm-tags}", ArrayToString(CurrentPlayer.ReadOnlyTags())));
+#endif
 
             var replacedMessage = template;
             placeholders.ForEach(placeholder =>
@@ -48,5 +56,21 @@ public static string BuildWithTemplate(string template, string message = null)
                 yield return ("{env." + key + "}", env[key] as string);
             }
         }
+
+        private static string ArrayToString(string[] tags)
+        {
+            var builder = new StringBuilder();
+            foreach (var tag in tags)
+            {
+                if (builder.Length > 0)
+                {
+                    builder.Append(" ");
+                }
+
+                builder.Append($"`{tag}`");
+            }
+
+            return builder.ToString();
+        }
     }
 }
diff --git a/Runtime/Settings/AutopilotState.cs b/Runtime/Settings/AutopilotState.cs
@@ -22,17 +22,21 @@ public class AutopilotState : ScriptableObject
         /// <summary>
         /// Launch type
         /// </summary>
-        [HideInInspector] public LaunchType launchFrom = LaunchType.NotSet;
+        [HideInInspector]
+        public LaunchType launchFrom = LaunchType.NotSet;
 
         /// <summary>
         /// Run autopilot settings instance
         /// </summary>
-        [HideInInspector] [CanBeNull] public AutopilotSettings settings;
+        [HideInInspector]
+        [CanBeNull]
+        public AutopilotSettings settings;
 
         /// <summary>
         /// Exit code when terminate autopilot from commandline interface
         /// </summary>
-        [HideInInspector] public ExitCode exitCode;
+        [HideInInspector]
+        public ExitCode exitCode;
 
         /// <summary>
         /// Reset run state
@@ -42,6 +46,9 @@ public void Reset()
             launchFrom = LaunchType.NotSet;
             settings = null;
             exitCode = ExitCode.Normally;
+#if UNITY_EDITOR
+            AssetDatabase.SaveAssetIfDirty(this); // Note: Sync with virtual players of MPPM package
+#endif
         }
 
         /// <summary>
@@ -59,7 +66,8 @@ public bool IsRunning
             }
         }
 
-        [NonSerialized] private static AutopilotState s_instance;
+        [NonSerialized]
+        private static AutopilotState s_instance;
 
         /// <summary>
         /// <c>AutopilotState</c> instance