fix: logic components remain active at suspended cells

Author: ASGAlex

lib/src/components/has_grid_support.dart

@@ -67,7 +67,8 @@ mixin HasGridSupport<G extends HasSpatialGridFramework> on PositionComponent
   @internal
   static final shapeHitboxIndex = HashMap<ShapeHitbox, int>();
 
-  static final componentsWithLogic = <HasGridSupport>[];
+  static final componentsWithLogic = <HasGridSupport>{};
+  static List<HasGridSupport> componentsWithLogicList = [];
   static bool componentsWithLogicChanged = true;
 
   @override
@@ -111,8 +112,21 @@ mixin HasGridSupport<G extends HasSpatialGridFramework> on PositionComponent
   bool noVisibleChildren = false;
   bool noChildrenToUpdate = true;
   bool noUpdateAutoCheck = true;
-  bool noUpdate = false;
-  bool noLogic = false;
+
+  bool get noUpdate => _noUpdate;
+  set noUpdate(bool value) {
+    _noUpdate = value;
+  }
+
+  bool _noUpdate = false;
+
+  bool get noLogic => _noLogic;
+  set noLogic(bool value) {
+    _noLogic = value;
+  }
+
+  bool _noLogic = false;
+
   bool checkOutOfCellBounds = true;
   bool needResize = false;
 
@@ -283,6 +297,18 @@ mixin HasGridSupport<G extends HasSpatialGridFramework> on PositionComponent
     position.addListener(_onPositionChanged);
     final result = super.onLoad();
 
+    checkNoUpdate();
+    checkNoLogic();
+
+    if (!noLogic && _logicPriority == 0) {
+      _logicPriority = parent!.ancestors(includeSelf: true).length;
+      componentsWithLogic.add(this);
+      componentsWithLogicChanged = true;
+    }
+    return result;
+  }
+
+  void checkNoUpdate() {
     noUpdate = false;
     try {
       update(0);
@@ -291,7 +317,9 @@ mixin HasGridSupport<G extends HasSpatialGridFramework> on PositionComponent
     } catch (error) {
       //suppress errors
     }
+  }
 
+  void checkNoLogic() {
     noLogic = false;
     try {
       logic(0);
@@ -300,8 +328,6 @@ mixin HasGridSupport<G extends HasSpatialGridFramework> on PositionComponent
     } catch (error) {
       //suppress errors
     }
-
-    return result;
   }
 
   int _logicPriority = 0;
@@ -325,15 +351,14 @@ mixin HasGridSupport<G extends HasSpatialGridFramework> on PositionComponent
       }
     }
 
-    if (!noLogic && _logicPriority == 0) {
-      _logicPriority = parent!.ancestors(includeSelf: true).length;
-      componentsWithLogic.add(this);
-      componentsWithLogicChanged = true;
+    if (_scheduledActionProvider == null) {
+      initActionProvider(
+        ScheduledActionProvider(
+          scheduler: game.scheduler,
+          actionFunction: onScheduledAction,
+        ),
+      );
     }
-    initActionProvider(ScheduledActionProvider(
-      scheduler: game.scheduler,
-      actionFunction: onScheduledAction,
-    ));
     super.onMount();
   }
 
@@ -460,11 +485,21 @@ mixin HasGridSupport<G extends HasSpatialGridFramework> on PositionComponent
 
   VoidCallback? onInactiveCallback;
 
-  void onInactive() {}
+  void onInactive() {
+    if (!noLogic) {
+      HasGridSupport.componentsWithLogic.remove(this);
+      HasGridSupport.componentsWithLogicChanged = true;
+    }
+  }
 
   VoidCallback? onActiveCallback;
 
-  void onActivate() {}
+  void onActivate() {
+    if (!noLogic) {
+      HasGridSupport.componentsWithLogic.add(this);
+      HasGridSupport.componentsWithLogicChanged = true;
+    }
+  }
 
   /// Called instead of [updateTree] when component is suspended.
   /// [dtElapsedWhileSuspended] accumulates all "dt" values since
@@ -473,15 +508,25 @@ mixin HasGridSupport<G extends HasSpatialGridFramework> on PositionComponent
 
   /// Called when component state changes to "suspended". You should stop
   /// all undesired component's movements (for example) here
-  void onSuspend() {}
+  void onSuspend() {
+    if (!noLogic) {
+      HasGridSupport.componentsWithLogic.remove(this);
+      HasGridSupport.componentsWithLogicChanged = true;
+    }
+  }
 
   VoidCallback? onSuspendCallback;
 
   /// Called when component state changes from "suspended" to active.
   /// [dtElapsedWhileSuspended] accumulates all "dt" values since
   /// component suspension. Useful to calculate next animation step as if
   /// the component was never suspended.
-  void onResume(double dtElapsedWhileSuspended) {}
+  void onResume(double dtElapsedWhileSuspended) {
+    if (!noLogic) {
+      HasGridSupport.componentsWithLogic.add(this);
+      HasGridSupport.componentsWithLogicChanged = true;
+    }
+  }
 
   Function(double dtElapsedWhileSuspended)? onResumeCallback;
 

lib/src/core/has_spatial_grid_framework.dart

@@ -5,7 +5,6 @@ import 'package:flame/extensions.dart';
 import 'package:flame/game.dart';
 import 'package:flame_spatial_grid/flame_spatial_grid.dart';
 import 'package:flame_spatial_grid/src/components/layers/scheduled_layer_operation.dart';
-import 'package:flame_spatial_grid/src/components/utility/scheduler/scheduler.dart';
 import 'package:flutter/foundation.dart';
 import 'package:meta/meta.dart';
 
@@ -708,7 +707,9 @@ mixin HasSpatialGridFramework<W extends World> on FlameGame<W>
 
         if (_logicUpdateDt >= logicUpdateInterval) {
           if (HasGridSupport.componentsWithLogicChanged) {
-            HasGridSupport.componentsWithLogic.sort(
+            HasGridSupport.componentsWithLogicList =
+                HasGridSupport.componentsWithLogic.toList(growable: false);
+            HasGridSupport.componentsWithLogicList.sort(
               (a, b) {
                 if (a.logicPriority == b.logicPriority) {
                   return 0;
@@ -738,7 +739,7 @@ mixin HasSpatialGridFramework<W extends World> on FlameGame<W>
 
   void logic(double dt) {
     scheduler.runActions(dt, ScheduledActionType.beforeLogic);
-    for (final component in HasGridSupport.componentsWithLogic) {
+    for (final component in HasGridSupport.componentsWithLogicList) {
       component.logic(dt);
     }
     scheduler.runActions(dt, ScheduledActionType.afterLogic);