refactor: Fix lint issues from latest flutter release (#3390)

Updates to use the new color method `withValues`. --------- Co-authored-by: Lukas Klingsbo <[email protected]> Co-authored-by: Jochum van der Ploeg <[email protected]>
flame-engine · Dec 13, 2024 · 978ad31 · 978ad31
1 parent d4094b2
commit 978ad31
Show file tree

Hide file tree

Showing 104 changed files with 284 additions and 150 deletions.
diff --git a/.github/.cspell/words_dictionary.txt b/.github/.cspell/words_dictionary.txt
@@ -31,3 +31,4 @@ tappable
 tappables
 toolset
 underutilize
+endianness
diff --git a/.github/workflows/cicd.yml b/.github/workflows/cicd.yml
@@ -9,7 +9,7 @@ on:
 
 
 env:
-  FLUTTER_MIN_VERSION: '3.24.0'
+  FLUTTER_MIN_VERSION: '3.27.0'
 
 jobs:
   # BEGIN LINTING STAGE

diff --git a/doc/flame/examples/lib/drag_events.dart b/doc/flame/examples/lib/drag_events.dart
@@ -127,7 +127,7 @@ class Trail extends Component {
       final path = _paths[i];
       final opacity = _opacities[i];
       if (opacity > 0) {
-        _linePaint.color = _color.withOpacity(opacity);
+        _linePaint.color = _color.withValues(alpha: opacity);
         _linePaint.strokeWidth = lineWidth * opacity;
         canvas.drawPath(path, _linePaint);
       }
@@ -216,11 +216,11 @@ class Star extends PositionComponent with DragCallbacks {
   @override
   void render(Canvas canvas) {
     if (isDragged) {
-      _paint.color = color.withOpacity(0.5);
+      _paint.color = color.withValues(alpha: 0.5);
       canvas.drawPath(_path, _paint);
       canvas.drawPath(_path, _borderPaint);
     } else {
-      _paint.color = color.withOpacity(1);
+      _paint.color = color.withValues(alpha: 1);
       canvas.drawPath(_path, _shadowPaint);
       canvas.drawPath(_path, _paint);
     }

diff --git a/doc/flame/examples/lib/pointer_events.dart b/doc/flame/examples/lib/pointer_events.dart
@@ -32,7 +32,7 @@ class HoverTarget extends PositionComponent with HoverCallbacks {
   final _paint = Paint()
     ..color = HSLColor.fromAHSL(1, _random.nextDouble() * 360, 1, 0.8)
         .toColor()
-        .withOpacity(0.5);
+        .withValues(alpha: 0.5);
 
   @override
   void render(Canvas canvas) {
@@ -41,11 +41,11 @@ class HoverTarget extends PositionComponent with HoverCallbacks {
 
   @override
   void onHoverEnter() {
-    _paint.color = _paint.color.withOpacity(1);
+    _paint.color = _paint.color.withValues(alpha: 1);
   }
 
   @override
   void onHoverExit() {
-    _paint.color = _paint.color.withOpacity(0.5);
+    _paint.color = _paint.color.withValues(alpha: 0.5);
   }
 }
diff --git a/doc/flame/examples/lib/ray_cast.dart b/doc/flame/examples/lib/ray_cast.dart
@@ -13,7 +13,7 @@ class RayCastExample extends FlameGame with HasCollisionDetection {
   final velocity = 60;
   double get resetPosition => -canvasSize.y;
 
-  Paint paint = Paint()..color = Colors.red.withOpacity(0.6);
+  Paint paint = Paint()..color = Colors.red.withValues(alpha: 0.6);
 
   RaycastResult<ShapeHitbox>? result;
 

diff --git a/doc/flame/examples/lib/ray_trace.dart b/doc/flame/examples/lib/ray_trace.dart
@@ -10,7 +10,7 @@ import 'package:flutter/material.dart';
 
 class RayTraceExample extends FlameGame
     with HasCollisionDetection, TapDetector {
-  Paint paint = Paint()..color = Colors.red.withOpacity(0.6);
+  Paint paint = Paint()..color = Colors.red.withValues(alpha: 0.6);
   bool isClicked = false;
 
   Vector2 get origin => canvasSize / 2;

diff --git a/doc/flame/examples/lib/tap_events.dart b/doc/flame/examples/lib/tap_events.dart
@@ -115,7 +115,7 @@ class ExpandingCircle extends Component {
       removeFromParent();
     } else {
       final opacity = 1 - radius / maxRadius;
-      _paint.color = _baseColor.withOpacity(opacity);
+      _paint.color = _baseColor.withValues(alpha: opacity);
       _paint.strokeWidth = _outerRadius - _innerRadius;
     }
   }

diff --git a/doc/flame/rendering/particles.md b/doc/flame/rendering/particles.md
@@ -250,7 +250,7 @@ game.add(
   ParticleSystemComponent(
     particle: CircleParticle(
       radius: game.size.x / 2,
-      paint: Paint()..color = Colors.red.withOpacity(.5),
+      paint: Paint()..color = Colors.red.withValues(alpha: .5),
     ),
   ),
 );

diff --git a/examples/games/padracing/lib/lap_line.dart b/examples/games/padracing/lib/lap_line.dart
@@ -31,7 +31,7 @@ class LapLine extends BodyComponent with ContactCallbacks {
   @override
   Body createBody() {
     paint.color = (isFinish ? GameColors.green.color : GameColors.green.color)
-      ..withOpacity(0.5);
+      ..withValues(alpha: 0.5);
     paint
       ..style = PaintingStyle.fill
       ..shader = Gradient.radial(

diff --git a/examples/games/padracing/lib/trail.dart b/examples/games/padracing/lib/trail.dart
@@ -20,7 +20,7 @@ class Trail extends Component with HasPaint {
   @override
   Future<void> onLoad() async {
     paint
-      ..color = (tire.paint.color.withOpacity(0.9))
+      ..color = (tire.paint.color.withValues(alpha: 0.9))
       ..strokeWidth = 1.0;
   }
 

diff --git a/examples/lib/stories/bridge_libraries/flame_forge2d/joints/mouse_joint.dart b/examples/lib/stories/bridge_libraries/flame_forge2d/joints/mouse_joint.dart
@@ -38,6 +38,9 @@ class MouseJointWorld extends Forge2DWorld
   @override
   void onDragStart(DragStartEvent info) {
     super.onDragStart(info);
+    if (mouseJoint != null) {
+      return;
+    }
     final mouseJointDef = MouseJointDef()
       ..maxForce = 3000 * ball.body.mass * 10
       ..dampingRatio = 0.1
@@ -47,10 +50,8 @@ class MouseJointWorld extends Forge2DWorld
       ..bodyA = groundBody
       ..bodyB = ball.body;
 
-    if (mouseJoint == null) {
-      mouseJoint = MouseJoint(mouseJointDef);
-      createJoint(mouseJoint!);
-    }
+    mouseJoint = MouseJoint(mouseJointDef);
+    createJoint(mouseJoint!);
   }
 
   @override

diff --git a/examples/lib/stories/camera_and_viewport/camera_component_properties_example.dart b/examples/lib/stories/camera_and_viewport/camera_component_properties_example.dart
@@ -147,7 +147,7 @@ class ExpandingCircle extends CircleComponent {
       removeFromParent();
     } else {
       final opacity = 1 - radius / maxRadius;
-      paint.color = const Color(0xffffffff).withOpacity(opacity);
+      paint.color = const Color(0xffffffff).withValues(alpha: opacity);
     }
   }
 }
diff --git a/examples/lib/stories/camera_and_viewport/fixed_resolution_example.dart b/examples/lib/stories/camera_and_viewport/fixed_resolution_example.dart
@@ -127,7 +127,8 @@ class TextButton extends ButtonComponent {
           ),
           buttonDown: RectangleComponent(
             size: Vector2(200, 100),
-            paint: Paint()..color = BasicPalette.orange.color.withOpacity(0.5),
+            paint: Paint()
+              ..color = BasicPalette.orange.color.withValues(alpha: 0.5),
           ),
           children: [
             TextComponent(

diff --git a/examples/lib/stories/collision_detection/multiple_shapes_example.dart b/examples/lib/stories/collision_detection/multiple_shapes_example.dart
@@ -94,8 +94,8 @@ abstract class MyCollidable extends PositionComponent
   final Vector2 velocity;
   final delta = Vector2.zero();
   double angleDelta = 0;
-  final Color _defaultColor = Colors.blue.withOpacity(0.8);
-  final Color _collisionColor = Colors.green.withOpacity(0.8);
+  final Color _defaultColor = Colors.blue.withValues(alpha: 0.8);
+  final Color _collisionColor = Colors.green.withValues(alpha: 0.8);
   late final Paint _dragIndicatorPaint;
   final ScreenHitbox screenHitbox;
   ShapeHitbox? hitbox;
@@ -219,7 +219,7 @@ class CollidableCircle extends MyCollidable {
 class SnowmanPart extends CircleHitbox {
   @override
   final renderShape = true;
-  final startColor = Colors.white.withOpacity(0.8);
+  final startColor = Colors.white.withValues(alpha: 0.8);
   final Color hitColor;
 
   SnowmanPart(double radius, Vector2 position, this.hitColor)
@@ -234,7 +234,7 @@ class SnowmanPart extends CircleHitbox {
     if (other.hitboxParent is ScreenHitbox) {
       paint.color = startColor;
     } else {
-      paint.color = hitColor.withOpacity(0.8);
+      paint.color = hitColor.withValues(alpha: 0.8);
     }
   }
 

diff --git a/examples/lib/stories/collision_detection/raycast_example.dart b/examples/lib/stories/collision_detection/raycast_example.dart
@@ -17,7 +17,7 @@ around trying not to hit them.
   Ray2? ray;
   Ray2? reflection;
   Vector2 origin = Vector2(250, 100);
-  Paint paint = Paint()..color = Colors.amber.withOpacity(0.6);
+  Paint paint = Paint()..color = Colors.amber.withValues(alpha: 0.6);
   final speed = 100;
   final inertia = 3.0;
   final safetyDistance = 50;

diff --git a/examples/lib/stories/collision_detection/raycast_light_example.dart b/examples/lib/stories/collision_detection/raycast_light_example.dart
@@ -28,8 +28,8 @@ with with mouse.
   Paint tapPaint = Paint();
 
   final _colorTween = ColorTween(
-    begin: Colors.blue.withOpacity(0.2),
-    end: Colors.red.withOpacity(0.2),
+    begin: Colors.blue.withValues(alpha: 0.2),
+    end: Colors.red.withValues(alpha: 0.2),
   );
 
   static const numberOfRays = 2000;

diff --git a/examples/lib/stories/collision_detection/raytrace_example.dart b/examples/lib/stories/collision_detection/raytrace_example.dart
@@ -23,8 +23,8 @@ bounce on will appear.
   ''';
 
   final _colorTween = ColorTween(
-    begin: Colors.amber.withOpacity(1.0),
-    end: Colors.lightBlueAccent.withOpacity(1.0),
+    begin: Colors.amber.withValues(alpha: 1.0),
+    end: Colors.lightBlueAccent.withValues(alpha: 1.0),
   );
   final random = Random();
   Ray2? ray;

diff --git a/examples/lib/stories/components/keys_example.dart b/examples/lib/stories/components/keys_example.dart
@@ -106,13 +106,13 @@ class SelectableClass extends SpriteComponent {
     super.size,
     super.key,
     super.sprite,
-  }) : super(paint: Paint()..color = Colors.white.withOpacity(0.5));
+  }) : super(paint: Paint()..color = Colors.white.withValues(alpha: 0.5));
 
   bool _selected = false;
   bool get selected => _selected;
   set selected(bool value) {
     _selected = value;
     paint = Paint()
-      ..color = value ? Colors.white : Colors.white.withOpacity(0.5);
+      ..color = value ? Colors.white : Colors.white.withValues(alpha: 0.5);
   }
 }
diff --git a/examples/lib/stories/effects/opacity_effect_example.dart b/examples/lib/stories/effects/opacity_effect_example.dart
@@ -42,7 +42,7 @@ class OpacityEffectExample extends FlameGame with TapDetector {
 
   @override
   void onTap() {
-    final opacity = sprite.paint.color.opacity;
+    final opacity = sprite.paint.color.a;
     if (opacity >= 0.5) {
       sprite.add(OpacityEffect.fadeOut(EffectController(duration: 1)));
     } else {

diff --git a/examples/lib/stories/input/overlapping_tap_callbacks_example.dart b/examples/lib/stories/input/overlapping_tap_callbacks_example.dart
@@ -30,7 +30,7 @@ class TapCallbacksSquare extends RectangleComponent with TapCallbacks {
           position: position ?? Vector2.all(100),
           size: Vector2.all(100),
           paint: continuePropagation
-              ? (Paint()..color = Colors.green.withOpacity(0.9))
+              ? (Paint()..color = Colors.green.withValues(alpha: 0.9))
               : PaintExtension.random(withAlpha: 0.9, base: 100),
         );
 

diff --git a/examples/lib/stories/rendering/particles_example.dart b/examples/lib/stories/rendering/particles_example.dart
@@ -432,7 +432,8 @@ class ParticlesExample extends FlameGame {
             renderer: (canvas, particle) {
               final paint = randomElement(paints);
               // Override the color to dynamically update opacity
-              paint.color = paint.color.withOpacity(1 - particle.progress);
+              paint.color =
+                  paint.color.withValues(alpha: 1 - particle.progress);
 
               canvas.drawCircle(
                 Offset.zero,

diff --git a/packages/flame/lib/src/components/mixins/has_paint.dart b/packages/flame/lib/src/components/mixins/has_paint.dart
@@ -83,12 +83,15 @@ mixin HasPaint<T extends Object> on Component
       throw ArgumentError('Opacity needs to be between 0 and 1');
     }
 
-    setColor(getPaint(paintId).color.withOpacity(opacity), paintId: paintId);
+    setColor(
+      getPaint(paintId).color.withValues(alpha: opacity),
+      paintId: paintId,
+    );
   }
 
   /// Returns the current opacity.
   double getOpacity({T? paintId}) {
-    return getPaint(paintId).color.opacity;
+    return getPaint(paintId).color.a;
   }
 
   /// Changes the opacity of the paint.
@@ -102,7 +105,7 @@ mixin HasPaint<T extends Object> on Component
 
   /// Returns the current opacity.
   int getAlpha({T? paintId}) {
-    return getPaint(paintId).color.alpha;
+    return getPaint(paintId).color.a ~/ 255;
   }
 
   /// Shortcut for changing the color of the paint.
@@ -118,13 +121,13 @@ mixin HasPaint<T extends Object> on Component
   }
 
   @override
-  double get opacity => paint.color.opacity;
+  double get opacity => paint.color.a;
 
   @override
   set opacity(double value) {
-    paint.color = paint.color.withOpacity(value);
+    paint.color = paint.color.withValues(alpha: value);
     for (final paint in _paints.values) {
-      paint.color = paint.color.withOpacity(value);
+      paint.color = paint.color.withValues(alpha: value);
     }
   }
 
@@ -186,7 +189,7 @@ class _MultiPaintOpacityProvider<T extends Object> implements OpacityProvider {
     ];
     _layerOpacityRatios = target.paintLayersInternal
         ?.map(
-          (paint) => paint.color.opacity / maxOpacity,
+          (paint) => paint.color.a / maxOpacity,
         )
         .toList(growable: false);
   }
@@ -206,7 +209,7 @@ class _MultiPaintOpacityProvider<T extends Object> implements OpacityProvider {
     }
     if (includeLayers) {
       target.paintLayersInternal?.forEach(
-        (paint) => maxOpacity = max(paint.color.opacity, maxOpacity),
+        (paint) => maxOpacity = max(paint.color.a, maxOpacity),
       );
     }
 
@@ -226,7 +229,7 @@ class _MultiPaintOpacityProvider<T extends Object> implements OpacityProvider {
       for (var i = 0; i < (paintLayersInternal?.length ?? 0); ++i) {
         paintLayersInternal![i].color = paintLayersInternal[i]
             .color
-            .withOpacity(value * _layerOpacityRatios![i]);
+            .withValues(alpha: value * _layerOpacityRatios![i]);
       }
     }
   }

diff --git a/packages/flame/lib/src/effects/color_effect.dart b/packages/flame/lib/src/effects/color_effect.dart
@@ -43,8 +43,8 @@ class ColorEffect extends ComponentEffect<HasPaint> {
 
   @override
   void apply(double progress) {
-    final currentColor = color.withOpacity(
-      min(max(_tween.transform(progress), 0), 1),
+    final currentColor = color.withValues(
+      alpha: min(max(_tween.transform(progress), 0), 1),
     );
     target.tint(currentColor, paintId: paintId);
   }

diff --git a/packages/flame/lib/src/extensions/color.dart b/packages/flame/lib/src/extensions/color.dart
@@ -14,10 +14,10 @@ extension ColorExtension on Color {
 
     final f = 1 - amount;
     return Color.fromARGB(
-      alpha,
-      (red * f).round(),
-      (green * f).round(),
-      (blue * f).round(),
+      a ~/ 255,
+      (r * f).round(),
+      (g * f).round(),
+      (b * f).round(),
     );
   }
 
@@ -30,10 +30,10 @@ extension ColorExtension on Color {
     assert(amount >= 0 && amount <= 1);
 
     return Color.fromARGB(
-      alpha,
-      red + ((255 - red) * amount).round(),
-      green + ((255 - green) * amount).round(),
-      blue + ((255 - blue) * amount).round(),
+      a ~/ 255,
+      (r + ((1.0 - r) * amount)) ~/ 255,
+      (g + ((1.0 - g) * amount)) ~/ 255,
+      (b + ((1.0 - b) * amount)) ~/ 255,
     );
   }
-Original file line number
+Diff line change
@@ Expand Up / @@ -9,7 +9,7 @@ on: @@
     env:
-      FLUTTER_MIN_VERSION: '3.24.0'
+      FLUTTER_MIN_VERSION: '3.27.0'
     jobs:
       # BEGIN LINTING STAGE
@@ Expand Down @@