com.elestrago.unity.entitas-redux 3.1.0 → 3.1.2

package/CHANGELOG.md

@@ -6,6 +6,22 @@ All notable changes to this project will be documented in this file.
 
 ---
 
+## [3.1.2](https://gitlab.com/elestrago-pkg/entitas-redux/-/tags/3.1.2)
+
+### Added
+
+- Execution type in `Event` attribute
+
+---
+
+## [3.1.1](https://gitlab.com/elestrago-pkg/entitas-redux/-/tags/3.1.1)
+
+### Fixes
+
+- Try to make package visible in Unity package manager
+
+---
+
 ## [v3.1.0](https://gitlab.com/elestrago-pkg/entitas-redux/-/tags/v3.1.0)
 
 ### Changes

package/Core/Attributes/EventAttribute.cs

@@ -32,15 +32,23 @@ namespace JCMG.EntitasRedux
 		AllowMultiple = true)]
 	public class EventAttribute : Attribute
 	{
-		public readonly EventTarget eventTarget;
-		public readonly EventType eventType;
-		public readonly int priority;
-
-		public EventAttribute(EventTarget eventTarget, EventType eventType = EventType.Added, int priority = 0)
+		public readonly EventTarget EventTarget;
+		public readonly EventType EventType;
+		public readonly ExecutionType ExecutionType;
+		public readonly int Priority;
+
+
+		public EventAttribute(
+			EventTarget eventTarget,
+			EventType eventType = EventType.Added,
+			ExecutionType executionType = ExecutionType.Update,
+			int priority = 0
+		)
 		{
-			this.eventTarget = eventTarget;
-			this.eventType = eventType;
-			this.priority = priority;
+			EventTarget = eventTarget;
+			ExecutionType = executionType;
+			EventType = eventType;
+			Priority = priority;
 		}
 	}
-}
+}

package/Core/Attributes/EventTarget.cs

@@ -1,6 +1,6 @@
 namespace JCMG.EntitasRedux
 {
-	public enum EventTarget
+	public enum EventTarget : byte
 	{
 		Any,
 		Self

package/Core/Attributes/EventType.cs

@@ -1,6 +1,6 @@
 namespace JCMG.EntitasRedux
 {
-	public enum EventType
+	public enum EventType : byte
 	{
 		Added,
 		Removed

package/Core/Attributes/ExecutionType.cs

@@ -0,0 +1,8 @@
+namespace JCMG.EntitasRedux
+{
+	public enum ExecutionType : byte
+	{
+		Update,
+		LateUpdate
+	}
+}

package/Core/Attributes/ExecutionType.cs.meta

@@ -0,0 +1,3 @@
+fileFormatVersion: 2
+guid: 07b584639f594d6e98b4e8811bbcc688
+timeCreated: 1738822225

package/Core/Systems/CleanupReactiveSystem.cs

@@ -73,11 +73,6 @@ namespace JCMG.EntitasRedux
 
 		public override string ToString() => _toStringCache ??= "ReactiveSystem(" + GetType().Name + ")";
 
-		~CleanupReactiveSystem()
-		{
-			Deactivate();
-		}
-
 		/// <summary>
 		/// Activates the ReactiveSystem and starts observing changes
 		/// based on the specified Collector.

package/Core/Systems/FixedReactiveSystem.cs

@@ -59,10 +59,5 @@ namespace JCMG.EntitasRedux
 		}
 
 		public override string ToString() => _toStringCache ??= "ReactiveSystem(" + GetType().Name + ")";
-
-		~FixedReactiveSystem()
-		{
-			Deactivate();
-		}
 	}
 }

package/Core/Systems/LateReactiveSystem.cs

@@ -0,0 +1,124 @@
+/*
+
+MIT License
+
+Copyright (c) 2020 Jeff Campbell
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+*/
+
+using System;
+
+namespace JCMG.EntitasRedux
+{
+	/// <summary>
+	/// A ReactiveSystem calls Execute(entities) if there were changes based on
+	/// the specified Collector and will only pass in changed entities.
+	/// A common use-case is to react to changes, e.g. a change of the position
+	/// of an entity to update the gameObject.transform.position
+	/// of the related gameObject.
+	/// </summary>
+	/// <typeparam name="TEntity"></typeparam>
+	public abstract class LateReactiveSystem<TEntity> : IReactiveSystem, ILateUpdateSystem
+		where TEntity : class, IEntity
+	{
+		private readonly ICollector<TEntity> _collector;
+		private readonly Func<TEntity, bool> _filterCached;
+
+		private string _toStringCache;
+
+		protected LateReactiveSystem(IContext<TEntity> context)
+		{
+			_collector = GetTrigger(context);
+			_filterCached = Filter;
+		}
+
+		protected LateReactiveSystem(ICollector<TEntity> collector)
+		{
+			_collector = collector;
+			_filterCached = Filter;
+		}
+
+		/// <summary>
+		/// Specify the collector that will trigger the ReactiveSystem.
+		/// </summary>
+		/// <param name="context"></param>
+		/// <returns></returns>
+		protected abstract ICollector<TEntity> GetTrigger(IContext<TEntity> context);
+
+		/// <summary>
+		/// This will exclude all entities which don't pass the filter.
+		/// </summary>
+		/// <param name="entity"></param>
+		/// <returns></returns>
+		protected abstract bool Filter(TEntity entity);
+
+		protected abstract void Execute(ReadOnlySpan<TEntity> entities);
+
+		public override string ToString() => _toStringCache ??= "ReactiveSystem(" + GetType().Name + ")";
+
+		/// <summary>
+		/// Activates the ReactiveSystem and starts observing changes
+		/// based on the specified Collector.
+		/// ReactiveSystem are activated by default.
+		/// </summary>
+		public void Activate()
+		{
+			_collector.Activate();
+		}
+
+		/// <summary>
+		/// Deactivates the ReactiveSystem.
+		/// No changes will be tracked while deactivated.
+		/// This will also clear the ReactiveSystem.
+		/// ReactiveSystem are activated by default.
+		/// </summary>
+		public void Deactivate()
+		{
+			_collector.Deactivate();
+		}
+
+		/// <summary>
+		/// Clears all accumulated changes.
+		/// </summary>
+		public void Clear()
+		{
+			_collector.ClearCollectedEntities();
+		}
+
+		/// <summary>
+		/// Will call Execute(entities) with changed entities
+		/// if there are any. Otherwise it will not call Execute(entities).
+		/// </summary>
+		public void LateUpdate()
+		{
+			var count = _collector.Count;
+			if (count == 0)
+				return;
+
+			using var _ = _collector.GetEntities(_filterCached, out var buffer);
+			_collector.ClearCollectedEntities();
+
+			if (buffer.Length == 0)
+				return;
+
+			Execute(buffer);
+		}
+	}
+}

package/Core/Systems/LateReactiveSystem.cs.meta

@@ -0,0 +1,3 @@
+fileFormatVersion: 2
+guid: 65eee3b577124007a01af526231f6607
+timeCreated: 1738822951

package/Core/Systems/ReactiveSystem.cs

@@ -73,11 +73,6 @@ namespace JCMG.EntitasRedux
 
 		public override string ToString() => _toStringCache ??= "ReactiveSystem(" + GetType().Name + ")";
 
-		~ReactiveSystem()
-		{
-			Deactivate();
-		}
-
 		/// <summary>
 		/// Activates the ReactiveSystem and starts observing changes
 		/// based on the specified Collector.

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "com.elestrago.unity.entitas-redux",
-  "version": "3.1.0",
+  "version": "3.1.2",
   "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": "Scripting",
+  "category": "unity",
   "unity": "2022.3",
   "homepage": "https://gitlab.com/elestrago-pkg/entitas-redux",
   "documentationUrl": "https://gitlab.com/elestrago-pkg/entitas-redux/-/blob/main/README.md",