feat!: Return a list instead of a set from the collision detection methods

doc/bridge_packages/flame_behaviors/collision-detection.md

@@ -33,7 +33,7 @@ class MyEntityCollisionBehavior
     extends CollisionBehavior<MyCollidingEntity, MyParentEntity> {
   @override
   void onCollisionStart(
-    Set<Vector2> intersectionPoints,
+    List<Vector2> intersectionPoints,
     MyCollidingEntity other,
   ) {
     // We are starting colliding with MyCollidingEntity

doc/flame/collision_detection.md

@@ -81,7 +81,7 @@ Example:
 ```dart
 class MyCollidable extends PositionComponent with CollisionCallbacks {
   @override
-  void onCollision(Set<Vector2> points, PositionComponent other) {
+  void onCollision(List<Vector2> points, PositionComponent other) {
     if (other is ScreenHitbox) {
       //...
     } else if (other is YourOtherComponent) {
@@ -101,7 +101,7 @@ class MyCollidable extends PositionComponent with CollisionCallbacks {
 ```
 
 In this example we use Dart's `is` keyword to check what kind of component we collided with.
-The set of points is where the edges of the hitboxes intersect.
+The list of points is where the edges of the hitboxes intersect.
 
 Note that the `onCollision` method will be called on both `PositionComponent`s if they have both
 implemented the `onCollision` method, and also on both hitboxes. The same goes for the
@@ -137,7 +137,7 @@ save all the other `PositionComponent`s to this list:
 
 ```dart
 @override
-void onCollision(Set<Vector2> intersectionPoints, PositionComponent other) {
+void onCollision(List<Vector2> intersectionPoints, PositionComponent other) {
   collisionComponents.add(other);
   super.onCollision(intersectionPoints, other);
 }
@@ -395,7 +395,7 @@ class Bullet extends PositionComponent with CollisionCallbacks {
 
   @override
   void onCollisionStart(
-    Set<Vector2> intersectionPoints,
+    List<Vector2> intersectionPoints,
     PositionComponent other,
   ) {
     // Removes the component when it comes in contact with a Brick.

doc/flame/examples/lib/collision_detection.dart

@@ -55,7 +55,7 @@ class RectangleCollidable extends PositionComponent with CollisionCallbacks {
 
   @override
   void onCollisionStart(
-    Set<Vector2> intersectionPoints,
+    List<Vector2> intersectionPoints,
     PositionComponent other,
   ) {
     super.onCollisionStart(intersectionPoints, other);

doc/flame/other/performance.md

@@ -177,7 +177,7 @@ class Bullet extends SpriteComponent with CollisionCallbacks {
   }
 
   @override
-  void onCollisionStart(Set<Vector2> points, PositionComponent other) {
+  void onCollisionStart(List<Vector2> points, PositionComponent other) {
     super.onCollisionStart(points, other);
     // Return to pool on collision. No manual release needed.
     removeFromParent();

doc/tutorials/platformer/app/lib/actors/ember.dart

@@ -112,7 +112,7 @@ class EmberPlayer extends SpriteAnimationComponent
   }
 
   @override
-  void onCollision(Set<Vector2> intersectionPoints, PositionComponent other) {
+  void onCollision(List<Vector2> intersectionPoints, PositionComponent other) {
     if (other is GroundBlock || other is PlatformBlock) {
       if (intersectionPoints.length == 2) {
         // Calculate the collision normal and separation distance.

doc/tutorials/platformer/step_5.md

@@ -131,7 +131,7 @@ Now add the following `onCollision` method:
 
 ```dart
 @override
-void onCollision(Set<Vector2> intersectionPoints, PositionComponent other) {
+void onCollision(List<Vector2> intersectionPoints, PositionComponent other) {
   if (other is GroundBlock || other is PlatformBlock) {
     if (intersectionPoints.length == 2) {
       // Calculate the collision normal and separation distance.

doc/tutorials/space_shooter/app/lib/step6/main.dart

@@ -197,7 +197,7 @@ class Enemy extends SpriteAnimationComponent
 
   @override
   void onCollisionStart(
-    Set<Vector2> intersectionPoints,
+    List<Vector2> intersectionPoints,
     PositionComponent other,
   ) {
     super.onCollisionStart(intersectionPoints, other);

doc/tutorials/space_shooter/step_6.md

@@ -80,7 +80,7 @@ class Enemy extends SpriteAnimationComponent
 
   @override
   void onCollisionStart(
-    Set<Vector2> intersectionPoints,
+    List<Vector2> intersectionPoints,
     PositionComponent other,
   ) {
     super.onCollisionStart(intersectionPoints, other);
@@ -148,7 +148,7 @@ in order to add the explosion to the game:
 ```dart
   @override
   void onCollisionStart(
-    Set<Vector2> intersectionPoints,
+    List<Vector2> intersectionPoints,
     PositionComponent other,
   ) {
     super.onCollisionStart(intersectionPoints, other);

examples/games/crystal_ball/lib/src/game/entities/the_ball.dart

@@ -58,7 +58,7 @@ class TheBall extends PositionComponent
 
   @override
   void onCollisionStart(
-    Set<Vector2> intersectionPoints,
+    List<Vector2> intersectionPoints,
     PositionComponent other,
   ) {
     super.onCollisionStart(intersectionPoints, other);

examples/games/rogue_shooter/lib/components/bullet_component.dart

@@ -29,7 +29,7 @@ class BulletComponent extends SpriteAnimationComponent
 
   @override
   void onCollisionStart(
-    Set<Vector2> intersectionPoints,
+    List<Vector2> intersectionPoints,
     PositionComponent other,
   ) {
     super.onCollisionStart(intersectionPoints, other);

examples/games/rogue_shooter/lib/components/player_component.dart

@@ -59,7 +59,7 @@ class PlayerComponent extends SpriteAnimationComponent
 
   @override
   void onCollisionStart(
-    Set<Vector2> intersectionPoints,
+    List<Vector2> intersectionPoints,
     PositionComponent other,
   ) {
     super.onCollisionStart(intersectionPoints, other);

examples/games/trex/lib/player.dart

@@ -101,7 +101,7 @@ class Player extends SpriteAnimationGroupComponent<PlayerState>
 
   @override
   void onCollisionStart(
-    Set<Vector2> intersectionPoints,
+    List<Vector2> intersectionPoints,
     PositionComponent other,
   ) {
     super.onCollisionStart(intersectionPoints, other);

examples/lib/stories/camera_and_viewport/follow_component_example.dart

@@ -85,7 +85,7 @@ class MovableEmber extends Ember<FollowComponentExample>
 
   @override
   void onCollisionStart(
-    Set<Vector2> intersectionPoints,
+    List<Vector2> intersectionPoints,
     PositionComponent other,
   ) {
     super.onCollisionStart(intersectionPoints, other);

examples/lib/stories/collision_detection/bouncing_ball_example.dart

@@ -72,7 +72,7 @@ class Ball extends CircleComponent
 
   @override
   void onCollisionStart(
-    Set<Vector2> intersectionPoints,
+    List<Vector2> intersectionPoints,
     PositionComponent other,
   ) {
     super.onCollisionStart(intersectionPoints, other);

examples/lib/stories/collision_detection/circles_example.dart

@@ -58,7 +58,7 @@ class MyCollidable extends PositionComponent
 
   @override
   void onCollisionStart(
-    Set<Vector2> intersectionPoints,
+    List<Vector2> intersectionPoints,
     PositionComponent other,
   ) {
     super.onCollisionStart(intersectionPoints, other);

examples/lib/stories/collision_detection/collidable_animation_example.dart

@@ -108,7 +108,7 @@ class AnimatedComponent extends SpriteAnimationComponent
 
   @override
   void onCollisionStart(
-    Set<Vector2> intersectionPoints,
+    List<Vector2> intersectionPoints,
     PositionComponent other,
   ) {
     super.onCollisionStart(intersectionPoints, other);

examples/lib/stories/collision_detection/multiple_shapes_example.dart

@@ -147,7 +147,7 @@ abstract class MyCollidable extends PositionComponent
 
   @override
   void onCollisionStart(
-    Set<Vector2> intersectionPoints,
+    List<Vector2> intersectionPoints,
     PositionComponent other,
   ) {
     super.onCollisionStart(intersectionPoints, other);
@@ -229,7 +229,7 @@ class SnowmanPart extends CircleHitbox {
   }
 
   @override
-  void onCollisionStart(Set<Vector2> intersectionPoints, ShapeHitbox other) {
+  void onCollisionStart(List<Vector2> intersectionPoints, ShapeHitbox other) {
     super.onCollisionStart(intersectionPoints, other);
 
     if (other.hitboxParent is ScreenHitbox) {

examples/lib/stories/collision_detection/multiple_worlds_example.dart

@@ -61,7 +61,7 @@ class CollidableEmber extends Ember with CollisionCallbacks {
 
   @override
   void onCollisionStart(
-    Set<Vector2> intersectionPoints,
+    List<Vector2> intersectionPoints,
     PositionComponent other,
   ) {
     super.onCollisionStart(intersectionPoints, other);

examples/lib/stories/collision_detection/quadtree_example.dart

@@ -226,7 +226,7 @@ class Player extends SpriteComponent
 
   @override
   void onCollisionStart(
-    Set<Vector2> intersectionPoints,
+    List<Vector2> intersectionPoints,
     PositionComponent other,
   ) {
     final myCenter = Vector2(
@@ -295,7 +295,7 @@ class Bullet extends PositionComponent with CollisionCallbacks, HasPaint {
 
   @override
   void onCollisionStart(
-    Set<Vector2> intersectionPoints,
+    List<Vector2> intersectionPoints,
     PositionComponent other,
   ) {
     if (other is Brick) {

examples/lib/stories/components/time_scale_example.dart

@@ -109,7 +109,7 @@ class _Chopper extends SpriteAnimationComponent
 
   @override
   void onCollisionStart(
-    Set<Vector2> intersectionPoints,
+    List<Vector2> intersectionPoints,
     PositionComponent other,
   ) {
     if (other is _Chopper) {

examples/lib/stories/input/joystick_player.dart

@@ -32,7 +32,7 @@ class JoystickPlayer extends SpriteComponent
 
   @override
   void onCollisionStart(
-    Set<Vector2> intersectionPoints,
+    List<Vector2> intersectionPoints,
     PositionComponent other,
   ) {
     super.onCollisionStart(intersectionPoints, other);

examples/lib/stories/system/step_engine_example.dart

@@ -132,7 +132,7 @@ class _DetectorComponents extends CircleComponent with CollisionCallbacks {
 
   @override
   void onCollisionStart(
-    Set<Vector2> intersectionPoints,
+    List<Vector2> intersectionPoints,
     PositionComponent other,
   ) {
     paint.color = BasicPalette.black.color;

packages/flame/lib/src/collisions/collision_callbacks.dart

@@ -54,14 +54,14 @@ mixin GenericCollisionCallbacks<T> {
   /// [onCollision] is called in every tick when this object is colliding with
   /// [other].
   @mustCallSuper
-  void onCollision(Set<Vector2> intersectionPoints, T other) {
+  void onCollision(List<Vector2> intersectionPoints, T other) {
     onCollisionCallback?.call(intersectionPoints, other);
   }
 
   /// [onCollisionStart] is called in the first tick when this object starts
   /// colliding with [other].
   @mustCallSuper
-  void onCollisionStart(Set<Vector2> intersectionPoints, T other) {
+  void onCollisionStart(List<Vector2> intersectionPoints, T other) {
     activeCollisions.add(other);
     onCollisionStartCallback?.call(intersectionPoints, other);
   }
@@ -115,14 +115,14 @@ mixin CollisionCallbacks on Component
 
   @override
   @mustCallSuper
-  void onCollision(Set<Vector2> intersectionPoints, PositionComponent other) {
+  void onCollision(List<Vector2> intersectionPoints, PositionComponent other) {
     onCollisionCallback?.call(intersectionPoints, other);
   }
 
   @override
   @mustCallSuper
   void onCollisionStart(
-    Set<Vector2> intersectionPoints,
+    List<Vector2> intersectionPoints,
     PositionComponent other,
   ) {
     activeCollisions.add(other);
@@ -167,7 +167,7 @@ mixin CollisionCallbacks on Component
 /// `onCollisionStartCallback`.
 typedef CollisionCallback<T> =
     void Function(
-      Set<Vector2> intersectionPoints,
+      List<Vector2> intersectionPoints,
       T other,
     );
 

packages/flame/lib/src/collisions/collision_detection.dart

@@ -80,11 +80,11 @@ abstract class CollisionDetection<
 
   /// Check what the intersection points of two items are,
   /// returns an empty list if there are no intersections.
-  Set<Vector2> intersections(T itemA, T itemB);
+  List<Vector2> intersections(T itemA, T itemB);
 
-  void handleCollisionStart(Set<Vector2> intersectionPoints, T itemA, T itemB);
+  void handleCollisionStart(List<Vector2> intersectionPoints, T itemA, T itemB);
 
-  void handleCollision(Set<Vector2> intersectionPoints, T itemA, T itemB);
+  void handleCollision(List<Vector2> intersectionPoints, T itemA, T itemB);
 
   void handleCollisionEnd(T itemA, T itemB);
 

packages/flame/lib/src/collisions/collision_passthrough.dart

@@ -24,15 +24,15 @@ mixin CollisionPassthrough on CollisionCallbacks {
 
   @override
   @mustCallSuper
-  void onCollision(Set<Vector2> intersectionPoints, PositionComponent other) {
+  void onCollision(List<Vector2> intersectionPoints, PositionComponent other) {
     super.onCollision(intersectionPoints, other);
     passthroughParent?.onCollision(intersectionPoints, other);
   }
 
   @override
   @mustCallSuper
   void onCollisionStart(
-    Set<Vector2> intersectionPoints,
+    List<Vector2> intersectionPoints,
     PositionComponent other,
   ) {
     super.onCollisionStart(intersectionPoints, other);

packages/flame/lib/src/collisions/hitboxes/hitbox.dart

@@ -30,7 +30,7 @@ abstract class Hitbox<T extends Hitbox<T>>
   bool containsPoint(Vector2 point);
 
   /// Where this [Hitbox] has intersection points with another [Hitbox].
-  Set<Vector2> intersections(T other);
+  List<Vector2> intersections(T other);
 
   /// This should be a cheaper calculation than comparing the exact boundaries
   /// if the exact calculation is expensive.

packages/flame/lib/src/collisions/hitboxes/shape_hitbox.dart

@@ -158,7 +158,7 @@ mixin ShapeHitbox on ShapeComponent implements Hitbox<ShapeHitbox> {
 
   /// Where this [ShapeComponent] has intersection points with another shape
   @override
-  Set<Vector2> intersections(Hitbox other) {
+  List<Vector2> intersections(Hitbox other) {
     assert(
       other is ShapeComponent,
       'The intersection can only be performed between shapes',
@@ -218,7 +218,7 @@ mixin ShapeHitbox on ShapeComponent implements Hitbox<ShapeHitbox> {
 
   @override
   @mustCallSuper
-  void onCollision(Set<Vector2> intersectionPoints, ShapeHitbox other) {
+  void onCollision(List<Vector2> intersectionPoints, ShapeHitbox other) {
     onCollisionCallback?.call(intersectionPoints, other);
     if (hitboxParent is CollisionCallbacks &&
         triggersParentCollision &&
@@ -232,7 +232,7 @@ mixin ShapeHitbox on ShapeComponent implements Hitbox<ShapeHitbox> {
 
   @override
   @mustCallSuper
-  void onCollisionStart(Set<Vector2> intersectionPoints, ShapeHitbox other) {
+  void onCollisionStart(List<Vector2> intersectionPoints, ShapeHitbox other) {
     activeCollisions.add(other);
     onCollisionStartCallback?.call(intersectionPoints, other);
     if (hitboxParent is CollisionCallbacks &&

packages/flame/lib/src/collisions/standard_collision_detection.dart

@@ -18,7 +18,7 @@ class StandardCollisionDetection<B extends Broadphase<ShapeHitbox>>
   /// Check what the intersection points of two collidables are,
   /// returns an empty list if there are no intersections.
   @override
-  Set<Vector2> intersections(
+  List<Vector2> intersections(
     ShapeHitbox hitboxA,
     ShapeHitbox hitboxB,
   ) {
@@ -31,7 +31,7 @@ class StandardCollisionDetection<B extends Broadphase<ShapeHitbox>>
   /// [ShapeHitbox.hitboxParent] that they have collided with.
   @override
   void handleCollisionStart(
-    Set<Vector2> intersectionPoints,
+    List<Vector2> intersectionPoints,
     ShapeHitbox hitboxA,
     ShapeHitbox hitboxB,
   ) {
@@ -45,7 +45,7 @@ class StandardCollisionDetection<B extends Broadphase<ShapeHitbox>>
   /// [ShapeHitbox.hitboxParent] that they have collided with.
   @override
   void handleCollision(
-    Set<Vector2> intersectionPoints,
+    List<Vector2> intersectionPoints,
     ShapeHitbox hitboxA,
     ShapeHitbox hitboxB,
   ) {