com.elestrago.unity.entitas-redux 3.3.3 → 3.4.0

package/CHANGELOG.md

@@ -2,6 +2,14 @@
 
 ---
 
+## [3.4.0](https://gitlab.com/elestrago-pkg/entitas-redux/-/tags/3.4.0)
+
+### Removed
+
+- Unify Add and Replace methods for components
+
+---
+
 ## [3.3.3](https://gitlab.com/elestrago-pkg/entitas-redux/-/tags/3.3.3)
 
 ### Fixed

package/Core/Entity/Entity.cs

@@ -73,54 +73,6 @@ namespace JCMG.EntitasRedux
 			return new ContextInfo("No Context", componentNames, null);
 		}
 
-		private void ReplaceComponentInternal(int index, IComponent replacement)
-		{
-			// TODO VD PERFORMANCE
-			// _toStringCache = null;
-
-			var previousComponent = _components[index];
-			if (replacement != previousComponent)
-			{
-				_components[index] = replacement;
-				_componentsCache = null;
-				if (replacement != null)
-				{
-					using (_onComponentReplaced.Invokable(out var listeners))
-					{
-						foreach (var handler in listeners)
-							handler(this, index, previousComponent, replacement);
-					}
-				}
-				else
-				{
-					_componentIndicesCache = null;
-
-					// TODO VD PERFORMANCE
-					_toStringCache = null;
-
-					using (_onComponentRemoved.Invokable(out var listeners))
-					{
-						foreach (var handler in listeners)
-							handler(this, index, previousComponent);
-					}
-				}
-
-				// ReSharper disable once SuspiciousTypeConversion.Global
-				if (previousComponent is IDisposable disposable)
-					disposable.Dispose();
-
-				GetComponentPool(index).Push(previousComponent);
-			}
-			else
-			{
-				using (_onComponentReplaced.Invokable(out var listeners))
-				{
-					foreach (var handler in listeners)
-						handler(this, index, previousComponent, replacement);
-				}
-			}
-		}
-
 		/// <summary>
 		/// Returns a cached string to describe the entity
 		/// with the following format:
@@ -256,6 +208,7 @@ namespace JCMG.EntitasRedux
 		private readonly Event<EntityEvent> _onDestroyEntity = new();
 
 		private GenId _id;
+
 		public GenId Id => _id;
 
 		/// <summary>
@@ -318,52 +271,6 @@ namespace JCMG.EntitasRedux
 			_isEnabled = true;
 		}
 
-		/// <summary>
-		/// Adds a component at the specified index.
-		/// You can only have one component at an index.
-		/// Each component type must have its own constant index.
-		/// The preferred way is to use the
-		/// generated methods from the code generator.
-		/// </summary>
-		/// <param name="index"></param>
-		/// <param name="component"></param>
-		public void AddComponent(int index, IComponent component)
-		{
-			if (!_isEnabled)
-			{
-				throw new EntityIsNotEnabledException(
-					"Cannot add component '" +
-					_contextInfo.componentNames[index] +
-					"' to " +
-					this +
-					"!");
-			}
-
-			if (HasComponent(index))
-			{
-				throw new EntityAlreadyHasComponentException(
-					index,
-					"Cannot add component '" +
-					_contextInfo.componentNames[index] +
-					"' to " +
-					this +
-					"!",
-					"You should check if an entity already has the component " +
-					"before adding it or use entity.ReplaceComponent().");
-			}
-
-			_components[index] = component;
-			_componentsCache = null;
-			_componentIndicesCache = null;
-			_toStringCache = null;
-
-			using (_onComponentAdded.Invokable(out var listeners))
-			{
-				foreach (var handler in listeners)
-					handler(this, index, component);
-			}
-		}
-
 		/// <summary>
 		/// Removes a component at the specified index.
 		/// You can only remove a component at an index if it exists.
@@ -400,14 +307,14 @@ namespace JCMG.EntitasRedux
 		}
 
 		/// <summary>
-		/// Replaces an existing component at the specified index
+		/// Add or replace an existing component at the specified index
 		/// or adds it if it doesn't exist yet.
 		/// The preferred way is to use the
 		/// generated methods from the code generator.
 		/// </summary>
 		/// <param name="index"></param>
 		/// <param name="component"></param>
-		public void ReplaceComponent(int index, IComponent component)
+		public void AddComponent(int index, IComponent component)
 		{
 			if (!_isEnabled)
 			{
@@ -425,7 +332,69 @@ namespace JCMG.EntitasRedux
 			}
 			else if (component != null)
 			{
-				AddComponent(index, component);
+				AddComponentInternal(index, component);
+			}
+		}
+
+		private void AddComponentInternal(int index, IComponent component)
+		{
+			_components[index] = component;
+			_componentsCache = null;
+			_componentIndicesCache = null;
+			_toStringCache = null;
+
+			using (_onComponentAdded.Invokable(out var listeners))
+			{
+				foreach (var handler in listeners)
+					handler(this, index, component);
+			}
+		}
+
+		private void ReplaceComponentInternal(int index, IComponent replacement)
+		{
+			// TODO VD PERFORMANCE
+			// _toStringCache = null;
+
+			var previousComponent = _components[index];
+			if (replacement != previousComponent)
+			{
+				_components[index] = replacement;
+				_componentsCache = null;
+				if (replacement != null)
+				{
+					using (_onComponentReplaced.Invokable(out var listeners))
+					{
+						foreach (var handler in listeners)
+							handler(this, index, previousComponent, replacement);
+					}
+				}
+				else
+				{
+					_componentIndicesCache = null;
+
+					// TODO VD PERFORMANCE
+					_toStringCache = null;
+
+					using (_onComponentRemoved.Invokable(out var listeners))
+					{
+						foreach (var handler in listeners)
+							handler(this, index, previousComponent);
+					}
+				}
+
+				// ReSharper disable once SuspiciousTypeConversion.Global
+				if (previousComponent is IDisposable disposable)
+					disposable.Dispose();
+
+				GetComponentPool(index).Push(previousComponent);
+			}
+			else
+			{
+				using (_onComponentReplaced.Invokable(out var listeners))
+				{
+					foreach (var handler in listeners)
+						handler(this, index, previousComponent, replacement);
+				}
 			}
 		}
 

package/Core/Entity/IEntity.cs

@@ -60,7 +60,6 @@ namespace JCMG.EntitasRedux
 
 		void AddComponent(int index, IComponent component);
 		void RemoveComponent(int index);
-		void ReplaceComponent(int index, IComponent component);
 
 		IComponent GetComponent(int index);
 		IComponent[] GetComponents();

package/Runtime/Editor/Inspector/Entity/EntityDrawer.cs

@@ -442,7 +442,7 @@ public class ${ShortType}TypeDrawer : ITypeDrawer {
 
 						if (changed)
 						{
-							entity.ReplaceComponent(index, newComponent);
+							entity.AddComponent(index, newComponent);
 						}
 						else
 						{

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "com.elestrago.unity.entitas-redux",
-  "version": "3.3.3",
+  "version": "3.4.0",
   "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",