chore!: Kill deprecated HasGameRef

doc/flame/migration.md

@@ -7,6 +7,27 @@ major versions of Flame, together with the steps required to migrate your code.
 ## Migrating from v1.38.0 to v2.0.0
 
 
+### `HasGameRef` removed in favour of `HasGameReference`
+
+The deprecated `HasGameRef` mixin has been removed. Use `HasGameReference` instead, which is
+otherwise identical apart from not offering the `gameRef` alias — use `game`:
+
+```dart
+// Before
+class MyComponent extends Component with HasGameRef<MyGame> {
+  void doSomething() => gameRef.score++;
+}
+
+// After
+class MyComponent extends Component with HasGameReference<MyGame> {
+  void doSomething() => game.score++;
+}
+```
+
+The `game` getter, its setter (useful for mocking in tests), and the `findGame()` override all
+behave exactly as before.
+
+
 ### `onDragCancel` no longer delegates to `onDragEnd`
 
 `DragCallbacks.onDragCancel` used to convert the cancellation into an `onDragEnd` event by default,

doc/tutorials/platformer/step_2.md

@@ -152,7 +152,7 @@ class EmberPlayer extends SpriteAnimationComponent
 }
 ```
 
-This file uses the `HasGameRef` mixin which allows us to reach back to `ember_quest.dart` and
+This file uses the `HasGameReference` mixin which allows us to reach back to `ember_quest.dart` and
 leverage any of the variables or methods that are defined in the game class. You can see this in
 use with the line `game.images.fromCache('ember.png')`. Earlier, we loaded all the files into
 cache, so to use that file now, we call `fromCache` so it can be leveraged by the `SpriteAnimation`.

doc/tutorials/platformer/step_3.md

@@ -342,8 +342,8 @@ class PlatformBlock extends SpriteComponent
 }
 ```
 
-We are going to extend the Flame `SpriteComponent` and we will need the `HasGameRef` mixin to access
-our game class just like we did before. We are starting with the empty `onLoad` and `update`
+We are going to extend the Flame `SpriteComponent` and we will need the `HasGameReference` mixin to
+access our game class just like we did before. We are starting with the empty `onLoad` and `update`
 methods and we will begin adding code to create the functionality that is necessary for the game.
 
 The secret to any gaming engine is the game loop. This is an infinite loop that calls all the

packages/flame/lib/components.dart

@@ -28,8 +28,6 @@ export 'src/components/mixins/has_ancestor.dart';
 export 'src/components/mixins/has_auto_batched_children.dart'
     show HasAutoBatchedChildren;
 export 'src/components/mixins/has_decorator.dart' show HasDecorator;
-// ignore: deprecated_member_use_from_same_package
-export 'src/components/mixins/has_game_ref.dart' show HasGameRef;
 export 'src/components/mixins/has_game_reference.dart' show HasGameReference;
 export 'src/components/mixins/has_paint.dart';
 export 'src/components/mixins/has_time_scale.dart';

packages/flame/test/components/mixins/has_world_test.dart

@@ -20,7 +20,7 @@ class _ParentComponent extends Component {
 class _ChildComponent extends _ParentComponent with HasWorldReference<World> {}
 
 void main() {
-  group('HasGameRef', () {
+  group('HasWorldReference', () {
     testWithGame<FlameGame>('onRemove calls super', FlameGame.new, (
       game,
     ) async {

packages/flame/test/experimental/has_game_reference_test.dart

@@ -94,7 +94,7 @@ void main() {
       expect(game.calledFoo, true);
     });
 
-    testWithGame<_MyGame>('gameRef can be mocked', _MyGame.new, (game) async {
+    testWithGame<_MyGame>('game can be mocked', _MyGame.new, (game) async {
       final component = _BarComponent();
       await game.ensureAdd(component);
 

packages/flame/test/experimental/has_world_test.dart

@@ -70,7 +70,7 @@ void main() {
       expect(c.world.calledFoo, isTrue);
     });
 
-    testWithGame<_MyGame>('gameRef can be mocked', _MyGame.new, (game) async {
+    testWithGame<_MyGame>('game can be mocked', _MyGame.new, (game) async {
       final component = _BarComponent();
       await game.world.ensureAdd(component);