fix: Export ScalingParticle (#2928)

The `ScalingParticle` wasn't exported, this exports it and corrects the dartdocs.
flame-engine · Dec 17, 2023 · 3730cb1 · 3730cb1
1 parent b526aa1
commit 3730cb1
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 1 deletion.
diff --git a/packages/flame/lib/particles.dart b/packages/flame/lib/particles.dart
@@ -11,6 +11,7 @@ export 'src/particles/paint_particle.dart';
 export 'src/particles/particle.dart';
 export 'src/particles/rotating_particle.dart';
 export 'src/particles/scaled_particle.dart';
+export 'src/particles/scaling_particle.dart';
 export 'src/particles/sprite_animation_particle.dart';
 export 'src/particles/sprite_particle.dart';
 export 'src/particles/translated_particle.dart';
diff --git a/packages/flame/lib/src/particles/scaled_particle.dart b/packages/flame/lib/src/particles/scaled_particle.dart
@@ -3,8 +3,11 @@ import 'dart:ui';
 import 'package:flame/src/components/mixins/single_child_particle.dart';
 import 'package:flame/src/particles/curved_particle.dart';
 import 'package:flame/src/particles/particle.dart';
+import 'package:flame/src/particles/scaling_particle.dart';
 
-/// A particle which scales its child over the lifespan to the set scale.
+/// Statically scales the given child [Particle] by given [scale].
+///
+/// If you're looking to scale the child over time, consider [ScalingParticle].
 class ScaledParticle extends CurvedParticle with SingleChildParticle {
   @override
   Particle child;