fix!: Migrate from RawKeyEvent to KeyEvent

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

@@ -44,7 +44,7 @@ class EmberPlayer extends SpriteAnimationComponent
  }
 
  @override
- bool onKeyEvent(RawKeyEvent event, Set<LogicalKeyboardKey> keysPressed) {
+ bool onKeyEvent(KeyEvent event, Set<LogicalKeyboardKey> keysPressed) {
  horizontalDirection = 0;
  horizontalDirection += (keysPressed.contains(LogicalKeyboardKey.keyA) ||
  keysPressed.contains(LogicalKeyboardKey.arrowLeft))

doc/tutorials/platformer/app/pubspec.yaml

@@ -5,6 +5,7 @@ version: 1.0.0+1
 
 environment:
  sdk: ">=3.0.0 <4.0.0"
+ flutter: ^3.19.0-0
 
 dependencies:
  flame: ^1.14.0

examples/games/padracing/lib/padracing_game.dart

@@ -209,7 +209,7 @@ class PadRacingGame extends Forge2DGame with KeyboardEvents {
 
  @override
  KeyEventResult onKeyEvent(
- RawKeyEvent event,
+ KeyEvent event,
  Set<LogicalKeyboardKey> keysPressed,
  ) {
  super.onKeyEvent(event, keysPressed);

examples/games/trex/lib/trex_game.dart

@@ -88,7 +88,7 @@ class TRexGame extends FlameGame
 
  @override
  KeyEventResult onKeyEvent(
- RawKeyEvent event,
+ KeyEvent event,
  Set<LogicalKeyboardKey> keysPressed,
  ) {
  if (keysPressed.contains(LogicalKeyboardKey.enter) ||

examples/lib/stories/camera_and_viewport/camera_follow_and_world_bounds.dart

@@ -9,7 +9,7 @@ import 'package:flutter/services.dart';
 
 class CameraFollowAndWorldBoundsExample extends FlameGame
  with HasKeyboardHandlerComponents {
- static const description = ''' 
+ static const description = '''
  This example demonstrates camera following the player, but also obeying the
  world bounds (which are set up to leave a small margin around the visible
  part of the ground).
@@ -142,8 +142,8 @@ class Player extends PositionComponent with KeyboardHandler {
  }
 
  @override
- bool onKeyEvent(RawKeyEvent event, Set<LogicalKeyboardKey> keysPressed) {
- final isKeyDown = event is RawKeyDownEvent;
+ bool onKeyEvent(KeyEvent event, Set<LogicalKeyboardKey> keysPressed) {
+ final isKeyDown = event is KeyDownEvent;
  final keyLeft = (event.logicalKey == LogicalKeyboardKey.arrowLeft) ||
  (event.logicalKey == LogicalKeyboardKey.keyA);
  final keyRight = (event.logicalKey == LogicalKeyboardKey.arrowRight) ||

examples/lib/stories/camera_and_viewport/coordinate_systems_example.dart

@@ -155,10 +155,10 @@ class CoordinateSystemsExample extends FlameGame
  /// Camera controls.
  @override
  KeyEventResult onKeyEvent(
- RawKeyEvent event,
+ KeyEvent event,
  Set<LogicalKeyboardKey> keysPressed,
  ) {
- final isKeyDown = event is RawKeyDownEvent;
+ final isKeyDown = event is KeyDownEvent;
 
  if (event.logicalKey == LogicalKeyboardKey.keyA) {
  cameraVelocity.x = isKeyDown ? -1 : 0;

examples/lib/stories/camera_and_viewport/follow_component_example.dart

@@ -100,8 +100,8 @@ class MovableEmber extends Ember<FollowComponentExample>
  }
 
  @override
- bool onKeyEvent(RawKeyEvent event, Set<LogicalKeyboardKey> keysPressed) {
- final isKeyDown = event is RawKeyDownEvent;
+ bool onKeyEvent(KeyEvent event, Set<LogicalKeyboardKey> keysPressed) {
+ final isKeyDown = event is KeyDownEvent;
 
  final bool handled;
  if (event.logicalKey == LogicalKeyboardKey.keyA) {

examples/lib/stories/collision_detection/quadtree_example.dart

@@ -142,7 +142,7 @@ Press T button to toggle player to collide with other objects.
 
  @override
  KeyEventResult onKeyEvent(
- RawKeyEvent event,
+ KeyEvent event,
  Set<LogicalKeyboardKey> keysPressed,
  ) {
  for (final key in keysPressed) {

examples/lib/stories/input/keyboard_example.dart

@@ -39,14 +39,14 @@ class KeyboardExample extends FlameGame with KeyboardEvents {
 
  @override
  KeyEventResult onKeyEvent(
- RawKeyEvent event,
+ KeyEvent event,
  Set<LogicalKeyboardKey> keysPressed,
  ) {
- final isKeyDown = event is RawKeyDownEvent;
+ final isKeyDown = event is KeyDownEvent;
 
  // Avoiding repeat event as we are interested only in
  // key up and key down event.
- if (!event.repeat) {
+ if (key is! KeyRepeatEvent) {
  if (event.logicalKey == LogicalKeyboardKey.keyA) {
  _direction.x += isKeyDown ? -1 : 1;
  } else if (event.logicalKey == LogicalKeyboardKey.keyD) {

examples/lib/stories/system/without_flame_game_example.dart

@@ -30,10 +30,10 @@ class NoFlameGameExample extends Game with KeyboardEvents {
 
  @override
  KeyEventResult onKeyEvent(
- RawKeyEvent event,
+ KeyEvent event,
  Set<LogicalKeyboardKey> keysPressed,
  ) {
- final isKeyDown = event is RawKeyDownEvent;
+ final isKeyDown = event is KeyDownEvent;
 
  if (event.logicalKey == LogicalKeyboardKey.keyA) {
  velocity.x = isKeyDown ? -1 : 0;

examples/pubspec.yaml

@@ -7,7 +7,7 @@ version: 0.1.0
 
 environment:
  sdk: ">=3.0.0 <4.0.0"
- flutter: ">=3.13.0"
+ flutter: ^3.19.0-0
 
 dependencies:
  dashbook: ^0.1.12

packages/flame/lib/src/components/core/component_key.dart

@@ -20,6 +20,6 @@ class ComponentKey {
  int get hashCode => _internalHash;
 
  @override
- bool operator ==(dynamic other) =>
+ bool operator ==(Object other) =>
  other is ComponentKey && other._internalHash == _internalHash;
 }

packages/flame/lib/src/components/input/keyboard_listener_component.dart

@@ -23,8 +23,8 @@ class KeyboardListenerComponent extends Component with KeyboardHandler {
  final Map<LogicalKeyboardKey, KeyHandlerCallback> _keyDown;
 
  @override
- bool onKeyEvent(RawKeyEvent event, Set<LogicalKeyboardKey> keysPressed) {
- final isUp = event is RawKeyUpEvent;
+ bool onKeyEvent(KeyEvent event, Set<LogicalKeyboardKey> keysPressed) {
+ final isUp = event is KeyUpEvent;
 
  final handlers = isUp ? _keyUp : _keyDown;
  final handler = handlers[event.logicalKey];

packages/flame/lib/src/components/mixins/keyboard_handler.dart

@@ -6,7 +6,7 @@ import 'package:flutter/services.dart';
 /// Must be used in components that can only be added to games that are mixed
 /// with [HasKeyboardHandlerComponents].
 mixin KeyboardHandler on Component {
- bool onKeyEvent(RawKeyEvent event, Set<LogicalKeyboardKey> keysPressed) {
+ bool onKeyEvent(KeyEvent event, Set<LogicalKeyboardKey> keysPressed) {
  return true;
  }
 }

packages/flame/lib/src/events/flame_game_mixins/double_tap_dispatcher.dart

@@ -14,7 +14,7 @@ class DoubleTapDispatcherKey implements ComponentKey {
  int get hashCode => 20260645; // 'DoubleTapDispatcherKey' as hashCode
 
  @override
- bool operator ==(dynamic other) =>
+ bool operator ==(Object other) =>
  other is DoubleTapDispatcherKey && other.hashCode == hashCode;
 }
 

packages/flame/lib/src/events/flame_game_mixins/multi_drag_dispatcher.dart

@@ -20,7 +20,7 @@ class MultiDragDispatcherKey implements ComponentKey {
  int get hashCode => 91604879; // 'MultiDragDispatcherKey' as hashCode
 
  @override
- bool operator ==(dynamic other) =>
+ bool operator ==(Object other) =>
  other is MultiDragDispatcherKey && other.hashCode == hashCode;
 }
 

packages/flame/lib/src/events/flame_game_mixins/multi_tap_dispatcher.dart

@@ -17,7 +17,7 @@ class MultiTapDispatcherKey implements ComponentKey {
  int get hashCode => 401913931; // 'MultiTapDispatcherKey' as hashCode
 
  @override
- bool operator ==(dynamic other) =>
+ bool operator ==(Object other) =>
  other is MultiTapDispatcherKey && other.hashCode == hashCode;
 }
 

packages/flame/lib/src/events/flame_game_mixins/pointer_move_dispatcher.dart

@@ -66,6 +66,6 @@ class MouseMoveDispatcherKey implements ComponentKey {
  int get hashCode => 'MouseMoveDispatcherKey'.hashCode;
 
  @override
- bool operator ==(dynamic other) =>
+ bool operator ==(Object other) =>
  other is MouseMoveDispatcherKey && other.hashCode == hashCode;
 }

packages/flame/lib/src/game/game_widget/game_widget.dart

@@ -311,15 +311,18 @@ class GameWidgetState<T extends Game> extends State<GameWidget<T>> {
  }
  }
 
- KeyEventResult _handleKeyEvent(FocusNode focusNode, RawKeyEvent event) {
+ KeyEventResult _handleKeyEvent(FocusNode focusNode, KeyEvent event) {
  final game = currentGame;
 
  if (!_focusNode.hasPrimaryFocus) {
  return KeyEventResult.ignored;
  }
 
  if (game is KeyboardEvents) {
- return game.onKeyEvent(event, RawKeyboard.instance.keysPressed);
+ return game.onKeyEvent(
+ event,
+ HardwareKeyboard.instance.logicalKeysPressed,
+ );
  }
  return KeyEventResult.handled;
  }
@@ -361,7 +364,7 @@ class GameWidgetState<T extends Game> extends State<GameWidget<T>> {
  focusNode: _focusNode,
  autofocus: widget.autofocus,
  descendantsAreFocusable: true,
- onKey: _handleKeyEvent,
+ onKeyEvent: _handleKeyEvent,
  child: MouseRegion(
  cursor: currentGame.mouseCursor,
  child: Directionality(

packages/flame/lib/src/game/mixins/keyboard.dart

@@ -13,7 +13,7 @@ mixin HasKeyboardHandlerComponents<W extends World> on FlameGame<W>
  @override
  @mustCallSuper
  KeyEventResult onKeyEvent(
- RawKeyEvent event,
+ KeyEvent event,
  Set<LogicalKeyboardKey> keysPressed,
  ) {
  final blockedPropagation = !propagateToChildren<KeyboardHandler>(
@@ -34,7 +34,7 @@ mixin HasKeyboardHandlerComponents<W extends World> on FlameGame<W>
 /// Override [onKeyEvent] to customize the keyboard handling behavior.
 mixin KeyboardEvents on Game {
  KeyEventResult onKeyEvent(
- RawKeyEvent event,
+ KeyEvent event,
  Set<LogicalKeyboardKey> keysPressed,
  ) {
  assert(

packages/flame/pubspec.yaml

@@ -9,7 +9,7 @@ funding:
 
 environment:
  sdk: ">=3.0.0 <4.0.0"
- flutter: ">=3.13.0"
+ flutter: ^3.19.0-0
 
 dependencies:
  collection: ^1.17.1

packages/flame/test/components/keyboard_listener_component_test.dart

@@ -9,15 +9,15 @@ abstract class _KeyCallStub {
 
 class KeyCallStub extends Mock implements _KeyCallStub {}
 
-class MockRawKeyUpEvent extends Mock implements RawKeyUpEvent {
+class MockKeyUpEvent extends Mock implements KeyUpEvent {
  @override
  String toString({DiagnosticLevel minLevel = DiagnosticLevel.info}) {
  return super.toString();
  }
 }
 
-RawKeyUpEvent _mockKeyUp(LogicalKeyboardKey key) {
- final event = MockRawKeyUpEvent();
+KeyUpEvent _mockKeyUp(LogicalKeyboardKey key) {
+ final event = MockKeyUpEvent();
  when(() => event.logicalKey).thenReturn(key);
  return event;
 }

packages/flame/test/extensions/matrix4_test.dart

@@ -5,8 +5,6 @@ import 'package:flame_test/flame_test.dart';
 import 'package:mocktail/mocktail.dart';
 import 'package:test/test.dart';
 
-import '_help.dart';
-
 void main() {
  group('Matrix4Extension', () {
  final matrix4 = Matrix4.fromList([
@@ -106,4 +104,4 @@ void main() {
 
 // This need the mixin because Mock's == parameter is not nullable
 // but Matrix4's == parameter is nullable
-class MockMatrix4 extends Mock with NullableEqualsMixin implements Matrix4 {}
+class MockMatrix4 extends Mock implements Matrix4 {}

packages/flame/test/game/game_widget/game_widget_keyboard_test.dart

@@ -12,7 +12,7 @@ class _KeyboardEventsGame extends FlameGame with KeyboardEvents {
 
  @override
  KeyEventResult onKeyEvent(
- RawKeyEvent event,
+ KeyEvent event,
  Set<LogicalKeyboardKey> keysPressed,
  ) {
  this.keysPressed.add(event.character ?? 'none');
@@ -25,7 +25,7 @@ class _KeyboardHandlerComponent extends Component with KeyboardHandler {
  final List<String> keysPressed = [];
 
  @override
- bool onKeyEvent(RawKeyEvent event, Set<LogicalKeyboardKey> keysPressed) {
+ bool onKeyEvent(KeyEvent event, Set<LogicalKeyboardKey> keysPressed) {
  this.keysPressed.add(event.character ?? 'none');
  return false;
  }

packages/flame/test/game/game_widget/game_widget_test.dart

@@ -25,7 +25,7 @@ class _GameWithKeyboardEvents extends FlameGame with KeyboardEvents {
 
  @override
  KeyEventResult onKeyEvent(
- RawKeyEvent event,
+ KeyEvent event,
  Set<LogicalKeyboardKey> keysPressed,
  ) {
  keyEvents.add(event.logicalKey);
@@ -443,7 +443,7 @@ void main() {
  testWidgets('overlay handles keys', (tester) async {
  final overlayKeyEvents = <LogicalKeyboardKey>[];
  final overlayFocusNode = FocusNode(
- onKey: (_, keyEvent) {
+ onKeyEvent: (_, keyEvent) {
  overlayKeyEvents.add(keyEvent.logicalKey);
  return KeyEventResult.ignored;
  },
@@ -475,7 +475,7 @@ void main() {
  await simulateKeyDownEvent(LogicalKeyboardKey.keyA);
  await tester.pump();
 
- expect(game.keyEvents, <RawKeyEvent>[]);
+ expect(game.keyEvents, <KeyEvent>[]);
  expect(overlayKeyEvents, [LogicalKeyboardKey.keyA]);
  });
  });

packages/flame/test/game/mixins/keyboard_test.dart

@@ -3,27 +3,23 @@ import 'package:flame/input.dart';
 import 'package:flutter/material.dart';
 import 'package:flutter/services.dart';
 import 'package:flutter_test/flutter_test.dart';
-import 'package:mocktail/mocktail.dart';
 
 class _ValidGame extends FlameGame with KeyboardEvents {}
 
 class _InvalidGame extends FlameGame
  with HasKeyboardHandlerComponents, KeyboardEvents {}
 
-class _MockRawKeyEventData extends Mock implements RawKeyEventData {
- @override
- String toString({DiagnosticLevel minLevel = DiagnosticLevel.debug}) {
- return super.toString();
- }
-}
-
 void main() {
  group('Keyboard events', () {
  test(
  'game with KeyboardEvents can handle key events',
  () {
  final validGame = _ValidGame();
- final event = RawKeyDownEvent(data: _MockRawKeyEventData());
+ const event = KeyDownEvent(
+ physicalKey: PhysicalKeyboardKey.arrowUp,
+ logicalKey: LogicalKeyboardKey.arrowUp,
+ timeStamp: Duration.zero,
+ );
 
  // Should just work with the default implementation
  expect(
@@ -37,7 +33,11 @@ void main() {
  'cannot mix KeyboardEvent and HasKeyboardHandlerComponents together',
  () {
  final invalidGame = _InvalidGame();
- final event = RawKeyDownEvent(data: _MockRawKeyEventData());
+ const event = KeyDownEvent(
+ physicalKey: PhysicalKeyboardKey.arrowUp,
+ logicalKey: LogicalKeyboardKey.arrowUp,
+ timeStamp: Duration.zero,
+ );
 
  // Should throw an assertion error
  expect(

packages/flame_bloc/example/lib/src/game/components/player.dart

@@ -107,7 +107,7 @@ class PlayerComponent extends SpriteAnimationComponent
 
  @override
  bool onKeyEvent(
- RawKeyEvent event,
+ KeyEvent event,
  Set<LogicalKeyboardKey> keysPressed,
  ) {
  if (keysPressed.contains(LogicalKeyboardKey.tab)) {

packages/flame_bloc/example/pubspec.yaml

@@ -7,6 +7,7 @@ version: 1.0.0+1
 
 environment:
  sdk: ">=3.0.0 <4.0.0"
+ flutter: ^3.19.0-0
 
 dependencies:
  equatable: ^2.0.5