com.elestrago.unity.entitas-redux 3.3.0 → 3.3.1

package/CHANGELOG.md

@@ -2,6 +2,14 @@
 
 ---
 
+## [3.3.1](https://gitlab.com/elestrago-pkg/entitas-redux/-/tags/3.3.1)
+
+### Added
+
+- `Optional` flag to `CommandAttribute`
+
+---
+
 ## [3.3.0](https://gitlab.com/elestrago-pkg/entitas-redux/-/tags/3.3.0)
 
 ### Added

package/Core/Commands/CommandAttribute.cs

@@ -5,5 +5,6 @@ namespace JCMG.EntitasRedux.Commands
 	[AttributeUsage(AttributeTargets.Struct)]
 	public class CommandAttribute : Attribute
 	{
+		public bool Optional;
 	}
 }

package/Core/Commands/CommandBuffer.cs

@@ -1,4 +1,5 @@
 using System;
+using System.Reflection;
 using System.Threading;
 
 namespace JCMG.EntitasRedux.Commands
@@ -10,10 +11,21 @@ namespace JCMG.EntitasRedux.Commands
 		{
 			private static int _indexCounter;
 
-			internal static class Index<TCommand> where TCommand : struct
+			internal static class Info<TCommand> where TCommand : struct
 			{
 				// This value is calculated once per TCommand and cached.
-				public static readonly int Value = Interlocked.Increment(ref _indexCounter) - 1;
+				public static readonly int Index = Interlocked.Increment(ref _indexCounter) - 1;
+				public static readonly bool Optional;
+
+				static Info()
+				{
+					var type = typeof(TCommand);
+					var attribute = type.GetCustomAttribute<CommandAttribute>();
+					if (attribute == null)
+						return;
+
+					Optional = attribute.Optional;
+				}
 			}
 		}
 
@@ -26,7 +38,7 @@ namespace JCMG.EntitasRedux.Commands
 		/// </summary>
 		public void Register<TCommand>() where TCommand : struct
 		{
-			var index = CommandType.Index<TCommand>.Value;
+			var index = CommandType.Info<TCommand>.Index;
 
 			// Ensure the array is large enough, resizing if necessary.
 			if (index >= _pools.Length)
@@ -46,10 +58,13 @@ namespace JCMG.EntitasRedux.Commands
 			if (pool != null)
 				return ref pool.Create();
 
+			if (!CommandType.Info<TCommand>.Optional)
+			{
 #if DEBUG
-			throw new Exception($"[CommandBuffer] Command type '{typeof(TCommand).Name}' is not registered. " +
-			                    $"Call Register<{typeof(TCommand).Name}>() first. Command will be ignored.");
+				throw new Exception($"[CommandBuffer] Command type '{typeof(TCommand).Name}' is not registered. " +
+				                    $"Call Register<{typeof(TCommand).Name}>() first. Command will be ignored.");
 #endif
+			}
 
 			// Return a reference to a dummy variable to satisfy the ref return.
 			return ref Dummy<TCommand>.Value;
@@ -64,6 +79,9 @@ namespace JCMG.EntitasRedux.Commands
 				return;
 			}
 
+			if (CommandType.Info<TCommand>.Optional)
+				return;
+
 #if DEBUG
 			throw new Exception($"[CommandBuffer] Command type '{typeof(TCommand).Name}' is not registered. " +
 			                    $"Call Register<{typeof(TCommand).Name}>() first. Command will be ignored.");
@@ -78,7 +96,7 @@ namespace JCMG.EntitasRedux.Commands
 
 		private CommandPool<TCommand> GetPool<TCommand>() where TCommand : struct
 		{
-			var index = CommandType.Index<TCommand>.Value;
+			var index = CommandType.Info<TCommand>.Index;
 
 			// Use .Length for array boundary check.
 			if (index >= _pools.Length)
@@ -89,7 +107,7 @@ namespace JCMG.EntitasRedux.Commands
 
 		public void Clear<TCommand>() where TCommand : struct
 		{
-			var index = CommandType.Index<TCommand>.Value;
+			var index = CommandType.Info<TCommand>.Index;
 
 			// Use .Length for array boundary check.
 			if (index < _pools.Length)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "com.elestrago.unity.entitas-redux",
-  "version": "3.3.0",
+  "version": "3.3.1",
   "displayName": "JCMG Entitas Redux",
   "description": "Entitas Redux is an fast, accessible, and feature-rich ECS framework for Unity. It leverages code generation and an extensible plugin framework to make life easier for developers.",
   "category": "Unity",