com.wallstop-studios.dxmessaging 2.0.0-rc10 → 2.0.0-rc12

package/Editor/SetupCscRsp.cs

@@ -13,8 +13,12 @@ namespace DxMessaging.Editor
     [InitializeOnLoad]
     public static class SetupCscRsp
     {
-        private static readonly string RspFilePath =
-            Path.Combine(Application.dataPath, "..", "csc.rsp").Replace("\\", "/");
+        private static readonly string RspFilePath = Path.Combine(
+                Application.dataPath,
+                "..",
+                "csc.rsp"
+            )
+            .Replace("\\", "/");
 
         private static readonly string AnalyzerPathRelative =
             "Packages/com.wallstop-studios.dxmessaging/Editor/Analyzers/";
@@ -22,14 +26,15 @@ namespace DxMessaging.Editor
         private static readonly string LibraryPathRelative =
             "Library/PackageCache/com.wallstop-studios.dxmessaging/Editor/Analyzers/";
 
-        private static readonly string SourceGeneratorDllName = "WallstopStudios.DxMessaging.SourceGenerators.dll";
+        private static readonly string SourceGeneratorDllName =
+            "WallstopStudios.DxMessaging.SourceGenerators.dll";
 
         private static readonly string[] RequiredDllNames =
         {
             SourceGeneratorDllName,
             "Microsoft.CodeAnalysis.dll",
             "Microsoft.CodeAnalysis.CSharp.dll",
-            "System.Reflection.Metadata.dll"
+            "System.Reflection.Metadata.dll",
         };
 
         private static readonly string LibraryArgument = $"-a:\"{LibraryPathRelative}\"";
@@ -43,7 +48,9 @@ namespace DxMessaging.Editor
         private static void EnsureDLLsExistInAssets()
         {
             HashSet<string> dllNames = new();
-            foreach (string dllGuid in AssetDatabase.FindAssets("t:DefaultAsset", new[] { "Assets" }))
+            foreach (
+                string dllGuid in AssetDatabase.FindAssets("t:DefaultAsset", new[] { "Assets" })
+            )
             {
                 string dllPath = AssetDatabase.GUIDToAssetPath(dllGuid);
                 if (!dllPath.EndsWith(".dll"))
@@ -58,7 +65,11 @@ namespace DxMessaging.Editor
             string[] dllRelativeDirectories = { LibraryPathRelative, AnalyzerPathRelative };
 
             bool anyFound = false;
-            foreach (string requiredDllName in RequiredDllNames.Where(dllName => !dllNames.Contains(dllName)))
+            foreach (
+                string requiredDllName in RequiredDllNames.Where(dllName =>
+                    !dllNames.Contains(dllName)
+                )
+            )
             {
                 bool found = false;
                 foreach (string relativeDirectory in dllRelativeDirectories)
@@ -71,7 +82,8 @@ namespace DxMessaging.Editor
                             continue;
                         }
 
-                        const string pluginsDirectory = "Assets/Plugins/WallstopStudios.DxMessaging/";
+                        const string pluginsDirectory =
+                            "Assets/Plugins/WallstopStudios.DxMessaging/";
                         string outputAsset = $"{pluginsDirectory}{requiredDllName}";
                         Directory.CreateDirectory(pluginsDirectory);
                         if (!File.Exists(outputAsset))
@@ -86,8 +98,9 @@ namespace DxMessaging.Editor
                             Object loadedDll = AssetDatabase.LoadMainAssetAtPath(outputAsset);
                             AssetDatabase.SetLabels(loadedDll, new[] { "RoslynAnalyzer" });
                         }
-                        
-                        PluginImporter importer = AssetImporter.GetAtPath(outputAsset) as PluginImporter;
+
+                        PluginImporter importer =
+                            AssetImporter.GetAtPath(outputAsset) as PluginImporter;
                         if (importer != null)
                         {
                             importer.SetCompatibleWithAnyPlatform(false);
@@ -100,14 +113,17 @@ namespace DxMessaging.Editor
                     }
                     catch (Exception e)
                     {
-                        Debug.LogError($"Failed to copy {requiredDllName} to Assets, failed with {e}.");
+                        Debug.LogError(
+                            $"Failed to copy {requiredDllName} to Assets, failed with {e}."
+                        );
                     }
                 }
 
                 anyFound |= found;
                 Debug.Log(
-                    $"Missing required dll '{requiredDllName}', " +
-                    $"{(found ? "creation successful." : "WARNING! Manual creation required.")}");
+                    $"Missing required dll '{requiredDllName}', "
+                        + $"{(found ? "creation successful." : "WARNING! Manual creation required.")}"
+                );
             }
 
             if (anyFound)
@@ -143,4 +159,4 @@ namespace DxMessaging.Editor
         }
     }
 }
-#endif
+#endif

package/README.md

@@ -3,12 +3,13 @@ Game engine agnostic robust, synchronous pub/sub C# messaging solution, mostly g
 
 # To Install as Unity Package
 1. Open Unity Package Manager
-2. Open the Advanced Package Settings
-3. Add an entry for a new "Scoped Registry"
+2. (Optional) Enable Pre-release packages to get the latest, cutting-edge builds
+3. Open the Advanced Package Settings
+4. Add an entry for a new "Scoped Registry"
     - Name: `NPM`
     - URL: `https://registry.npmjs.org`
     - Scope(s): `com.wallstop-studios.dxmessaging` *and* `com.wallstop-studios.unity-helpers`
-4. Resolve the latest `DxMessaging`
+5. Resolve the latest `DxMessaging`
 
 # Dependencies
 This project has a dependency on my [`Unity Helpers`](https://github.com/wallstop/unity-helpers) project, which contains the `System.Runtime.CompilerServices.Unsafe.dll`, which is used for some speed hacks in DxMessaging directly. Unity Helpers bundles a few (small) dependencies, including protobuf. If you don't want these dependencies, or if they conflict in some way, you can either include a copy of the `System.Runtime.CompilerServices.Unsafe.dll` yourself without relying on UnityHelpers, or manually download and include the Unity Helpers project and delete anything that conflicts with your project. Or, manually download this project without UnityHelpers. The choice is yours.
@@ -17,12 +18,12 @@ This project has a dependency on my [`Unity Helpers`](https://github.com/wallsto
 DxMessaging is currently a bit slower (2-3x) than Unity's built in messaging solution (when running in Unity). [Source](./Tests/Runtime/Benchmarks/PerformanceTests.cs).
 | Message Tech | Operations / Second |
 | ------------ | ------------------- |
-| Unity | 2,101,721 |
-| DxMessaging (GameObject) - Normal | 889,760 |
-| DxMessaging (Component) - Normal | 869,437 |
-| DxMessaging (GameObject) - No-Copy | 871,880 |
-| DxMessaging (Component) - No-Copy | 899,361 |
-| DxMessaging (Untargeted) - No-Copy | 1,239,673 |
+| Unity | 2,509,901 |
+| DxMessaging (GameObject) - Normal | 1,031,034 |
+| DxMessaging (Component) - Normal | 1,066,371 |
+| DxMessaging (GameObject) - No-Copy | 1,001,639 |
+| DxMessaging (Component) - No-Copy | 1,080,738 |
+| DxMessaging (Untargeted) - No-Copy | 1,389,542 |
 
 # Functionality
 While not as fast, DxMessaging offers *additional functionality* as compared to Unity's messaging solution.

package/Runtime/Core/Attributes/DxAutoMessageTypeAttribute.cs

@@ -3,7 +3,5 @@
     using System;
 
     [AttributeUsage(AttributeTargets.Class | AttributeTargets.Struct)]
-    public sealed class DxAutoMessageTypeAttribute : Attribute
-    {
-    }
-}
+    public sealed class DxAutoMessageTypeAttribute : Attribute { }
+}

package/Runtime/Core/Attributes/DxBroadcastMessageAttribute.cs

@@ -3,8 +3,5 @@
     using System;
 
     [AttributeUsage(AttributeTargets.Class | AttributeTargets.Struct)]
-    public sealed class DxBroadcastMessageAttribute : Attribute
-    {
-        
-    }
-}
+    public sealed class DxBroadcastMessageAttribute : Attribute { }
+}

package/Runtime/Core/Attributes/DxTargetedMessageAttribute.cs

@@ -3,8 +3,5 @@
     using System;
 
     [AttributeUsage(AttributeTargets.Class | AttributeTargets.Struct)]
-    public sealed class DxTargetedMessageAttribute : Attribute
-    {
-        
-    }
-}
+    public sealed class DxTargetedMessageAttribute : Attribute { }
+}

package/Runtime/Core/Attributes/DxUntargetedMessageAttribute.cs

@@ -3,8 +3,5 @@
     using System;
 
     [AttributeUsage(AttributeTargets.Class | AttributeTargets.Struct)]
-    public sealed class DxUntargetedMessageAttribute : Attribute
-    {
-        
-    }
-}
+    public sealed class DxUntargetedMessageAttribute : Attribute { }
+}

package/Runtime/Core/Extensions/MessageExtensions.cs

@@ -9,7 +9,6 @@
     /// </summary>
     public static class MessageExtensions
     {
-
 #if UNITY_2017_1_OR_NEWER
         /// <summary>
         /// Emits a TargetedMessage of the given type.
@@ -17,7 +16,12 @@
         /// <param name="message">TargetedMessage to emit.</param>
         /// <param name="target">Target that this message is intended for.</param>
         /// <param name="messageBus">MessageBus to emit to. If null, uses the GlobalMessageBus.</param>
-        public static void EmitGameObjectTargeted<TMessage>(this TMessage message, UnityEngine.GameObject target, IMessageBus messageBus = null) where TMessage : class, ITargetedMessage
+        public static void EmitGameObjectTargeted<TMessage>(
+            this TMessage message,
+            UnityEngine.GameObject target,
+            IMessageBus messageBus = null
+        )
+            where TMessage : class, ITargetedMessage
         {
             InstanceId targetId = target;
             messageBus ??= MessageHandler.MessageBus;
@@ -36,7 +40,12 @@
         /// <param name="message">TargetedMessage to emit.</param>
         /// <param name="target">Target that this message is intended for.</param>
         /// <param name="messageBus">MessageBus to emit to. If null, uses the GlobalMessageBus.</param>
-        public static void EmitGameObjectTargeted<TMessage>(this ref TMessage message, UnityEngine.GameObject target, IMessageBus messageBus = null) where TMessage : struct, ITargetedMessage
+        public static void EmitGameObjectTargeted<TMessage>(
+            this ref TMessage message,
+            UnityEngine.GameObject target,
+            IMessageBus messageBus = null
+        )
+            where TMessage : struct, ITargetedMessage
         {
             InstanceId targetId = target;
             messageBus ??= MessageHandler.MessageBus;
@@ -55,7 +64,12 @@
         /// <param name="message">TargetedMessage to emit.</param>
         /// <param name="target">Target that this message is intended for.</param>
         /// <param name="messageBus">MessageBus to emit to. If null, uses the GlobalMessageBus.</param>
-        public static void EmitComponentTargeted<TMessage>(this TMessage message, UnityEngine.Component target, IMessageBus messageBus = null) where TMessage : class, ITargetedMessage
+        public static void EmitComponentTargeted<TMessage>(
+            this TMessage message,
+            UnityEngine.Component target,
+            IMessageBus messageBus = null
+        )
+            where TMessage : class, ITargetedMessage
         {
             InstanceId targetId = target;
             messageBus ??= MessageHandler.MessageBus;
@@ -74,7 +88,12 @@
         /// <param name="message">TargetedMessage to emit.</param>
         /// <param name="target">Target that this message is intended for.</param>
         /// <param name="messageBus">MessageBus to emit to. If null, uses the GlobalMessageBus.</param>
-        public static void EmitComponentTargeted<TMessage>(this ref TMessage message, UnityEngine.Component target, IMessageBus messageBus = null) where TMessage : struct, ITargetedMessage
+        public static void EmitComponentTargeted<TMessage>(
+            this ref TMessage message,
+            UnityEngine.Component target,
+            IMessageBus messageBus = null
+        )
+            where TMessage : struct, ITargetedMessage
         {
             InstanceId targetId = target;
             messageBus ??= MessageHandler.MessageBus;
@@ -88,14 +107,18 @@
         }
 #endif
 
-
         /// <summary>
         /// Emits a TargetedMessage of the given type.
         /// </summary>
         /// <param name="message">TargetedMessage to emit.</param>
         /// <param name="target">Target that this message is intended for.</param>
         /// <param name="messageBus">MessageBus to emit to. If null, uses the GlobalMessageBus.</param>
-        public static void EmitTargeted<TMessage>(this TMessage message, InstanceId target, IMessageBus messageBus = null) where TMessage : class, ITargetedMessage
+        public static void EmitTargeted<TMessage>(
+            this TMessage message,
+            InstanceId target,
+            IMessageBus messageBus = null
+        )
+            where TMessage : class, ITargetedMessage
         {
             messageBus ??= MessageHandler.MessageBus;
             if (typeof(TMessage) == typeof(ITargetedMessage))
@@ -113,7 +136,12 @@
         /// <param name="message">TargetedMessage to emit.</param>
         /// <param name="target">Target that this message is intended for.</param>
         /// <param name="messageBus">MessageBus to emit to. If null, uses the GlobalMessageBus.</param>
-        public static void EmitTargeted<TMessage>(this ref TMessage message, InstanceId target, IMessageBus messageBus = null) where TMessage : struct, ITargetedMessage
+        public static void EmitTargeted<TMessage>(
+            this ref TMessage message,
+            InstanceId target,
+            IMessageBus messageBus = null
+        )
+            where TMessage : struct, ITargetedMessage
         {
             messageBus ??= MessageHandler.MessageBus;
             if (typeof(TMessage) == typeof(ITargetedMessage))
@@ -130,7 +158,11 @@
         /// </summary>
         /// <param name="message">UntargetedMessage to emit.</param>
         /// <param name="messageBus">MessageBus to emit to. If null, uses the GlobalMessageBus.</param>
-        public static void EmitUntargeted<TMessage>(this TMessage message, IMessageBus messageBus = null) where TMessage : class, IUntargetedMessage
+        public static void EmitUntargeted<TMessage>(
+            this TMessage message,
+            IMessageBus messageBus = null
+        )
+            where TMessage : class, IUntargetedMessage
         {
             messageBus ??= MessageHandler.MessageBus;
             if (typeof(TMessage) == typeof(IUntargetedMessage))
@@ -147,7 +179,11 @@
         /// </summary>
         /// <param name="message">UntargetedMessage to emit.</param>
         /// <param name="messageBus">MessageBus to emit to. If null, uses the GlobalMessageBus.</param>
-        public static void EmitUntargeted<TMessage>(this ref TMessage message, IMessageBus messageBus = null) where TMessage : struct, IUntargetedMessage
+        public static void EmitUntargeted<TMessage>(
+            this ref TMessage message,
+            IMessageBus messageBus = null
+        )
+            where TMessage : struct, IUntargetedMessage
         {
             messageBus ??= MessageHandler.MessageBus;
             if (typeof(TMessage) == typeof(IUntargetedMessage))
@@ -166,7 +202,12 @@
         /// <param name="message">BroadcastMessage to emit.</param>
         /// <param name="source">Source of this message.</param>
         /// <param name="messageBus">MessageBus to emit to. If null, uses the GlobalMessageBus.</param>
-        public static void EmitGameObjectBroadcast<TMessage>(this TMessage message, UnityEngine.GameObject source, IMessageBus messageBus = null) where TMessage : class, IBroadcastMessage
+        public static void EmitGameObjectBroadcast<TMessage>(
+            this TMessage message,
+            UnityEngine.GameObject source,
+            IMessageBus messageBus = null
+        )
+            where TMessage : class, IBroadcastMessage
         {
             InstanceId sourceId = source;
             messageBus ??= MessageHandler.MessageBus;
@@ -185,7 +226,12 @@
         /// <param name="message">BroadcastMessage to emit.</param>
         /// <param name="source">Source of this message.</param>
         /// <param name="messageBus">MessageBus to emit to. If null, uses the GlobalMessageBus.</param>
-        public static void EmitGameObjectBroadcast<TMessage>(this ref TMessage message, UnityEngine.GameObject source, IMessageBus messageBus = null) where TMessage : struct, IBroadcastMessage
+        public static void EmitGameObjectBroadcast<TMessage>(
+            this ref TMessage message,
+            UnityEngine.GameObject source,
+            IMessageBus messageBus = null
+        )
+            where TMessage : struct, IBroadcastMessage
         {
             InstanceId sourceId = source;
             messageBus ??= MessageHandler.MessageBus;
@@ -204,7 +250,12 @@
         /// <param name="message">BroadcastMessage to emit.</param>
         /// <param name="source">Source of this message.</param>
         /// <param name="messageBus">MessageBus to emit to. If null, uses the GlobalMessageBus.</param>
-        public static void EmitComponentBroadcast<TMessage>(this TMessage message, UnityEngine.Component source, IMessageBus messageBus = null) where TMessage : class, IBroadcastMessage
+        public static void EmitComponentBroadcast<TMessage>(
+            this TMessage message,
+            UnityEngine.Component source,
+            IMessageBus messageBus = null
+        )
+            where TMessage : class, IBroadcastMessage
         {
             InstanceId sourceId = source;
             messageBus ??= MessageHandler.MessageBus;
@@ -223,7 +274,12 @@
         /// <param name="message">BroadcastMessage to emit.</param>
         /// <param name="source">Source of this message.</param>
         /// <param name="messageBus">MessageBus to emit to. If null, uses the GlobalMessageBus.</param>
-        public static void EmitComponentBroadcast<TMessage>(this ref TMessage message, UnityEngine.Component source, IMessageBus messageBus = null) where TMessage : struct, IBroadcastMessage
+        public static void EmitComponentBroadcast<TMessage>(
+            this ref TMessage message,
+            UnityEngine.Component source,
+            IMessageBus messageBus = null
+        )
+            where TMessage : struct, IBroadcastMessage
         {
             InstanceId sourceId = source;
             messageBus ??= MessageHandler.MessageBus;
@@ -236,13 +292,19 @@
             messageBus.SourcedBroadcast(ref sourceId, ref message);
         }
 #endif
+
         /// <summary>
         /// Emits a BroadcastMessage of the given type from the specified component.
         /// </summary>
         /// <param name="message">BroadcastMessage to emit.</param>
         /// <param name="source">Source of this message.</param>
         /// <param name="messageBus">MessageBus to emit to. If null, uses the GlobalMessageBus.</param>
-        public static void EmitBroadcast<TMessage>(this TMessage message, InstanceId source, IMessageBus messageBus = null) where TMessage : class, IBroadcastMessage
+        public static void EmitBroadcast<TMessage>(
+            this TMessage message,
+            InstanceId source,
+            IMessageBus messageBus = null
+        )
+            where TMessage : class, IBroadcastMessage
         {
             messageBus ??= MessageHandler.MessageBus;
             if (typeof(TMessage) == typeof(IBroadcastMessage))
@@ -260,7 +322,12 @@
         /// <param name="message">BroadcastMessage to emit.</param>
         /// <param name="source">Source of this message.</param>
         /// <param name="messageBus">MessageBus to emit to. If null, uses the GlobalMessageBus.</param>
-        public static void EmitBroadcast<TMessage>(this ref TMessage message, InstanceId source, IMessageBus messageBus = null) where TMessage : struct, IBroadcastMessage
+        public static void EmitBroadcast<TMessage>(
+            this ref TMessage message,
+            InstanceId source,
+            IMessageBus messageBus = null
+        )
+            where TMessage : struct, IBroadcastMessage
         {
             messageBus ??= MessageHandler.MessageBus;
             if (typeof(TMessage) == typeof(IBroadcastMessage))