Version 3.6.0

CHANGELOG.md

@@ -1,3 +1,9 @@
+# 3.6.0
+- Adds param `hudComponents` in `BonfireWidget`;
+- Adds `queryHud` method in `BonfireGameInterface`;
+- Adds `addHud` method in `BonfireGameInterface`;
+- Update Flame to `1.16.0`.
+
 # 3.5.0
 - Adds Parallax support
 - Background improvements.

example/lib/pages/input/keyboard/barrel_show_keyboard_input.dart

@@ -36,7 +36,7 @@ class BarrelShowKeyboardInput extends GameDecoration
   }
 
   @override
-  bool onKeyboard(RawKeyEvent event, Set<LogicalKeyboardKey> keysPressed) {
+  bool onKeyboard(KeyEvent event, Set<LogicalKeyboardKey> keysPressed) {
     input += event.character ?? '';
     return true;
   }

example/lib/pages/parallax/bonfire/bonfire_parallax_background.dart

@@ -2,9 +2,9 @@ import 'package:bonfire/bonfire.dart';
 
 class BonfireParallaxBackground extends GameBackground {
   @override
-  void onGameMounted() {
+  void onMount() {
     _addParallax();
-    super.onGameMounted();
+    super.onMount();
   }
 
   void _addParallax() async {

example/lib/pages/parallax/flame/parallax_background.dart

@@ -2,9 +2,9 @@ import 'package:bonfire/bonfire.dart';
 
 class ParallaxBackground extends GameBackground {
   @override
-  void onGameMounted() {
+  void onMount() {
     _addParallax();
-    super.onGameMounted();
+    super.onMount();
   }
 
   void _addParallax() async {

example/pubspec.lock

@@ -47,7 +47,7 @@ packages:
       path: ".."
       relative: true
     source: path
-    version: "3.4.0"
+    version: "3.5.0"
   boolean_selector:
     dependency: transitive
     description:
@@ -124,10 +124,10 @@ packages:
     dependency: transitive
     description:
       name: flame
-      sha256: "2a2352741500ce47823dcf212f06b23e9bdb622454eab90244ee6da58e23b488"
+      sha256: bb42a35fa5dabdea535daebe5b020e21a2fce8192b67b7e55cd30fed86d29f69
       url: "https://pub.dev"
     source: hosted
-    version: "1.15.0"
+    version: "1.16.0"
   flutter:
     dependency: "direct main"
     description: flutter
@@ -238,18 +238,18 @@ packages:
     dependency: transitive
     description:
       name: material_color_utilities
-      sha256: "9528f2f296073ff54cb9fee677df673ace1218163c3bc7628093e7eed5203d41"
+      sha256: "0e0a020085b65b6083975e499759762399b4475f766c21668c4ecca34ea74e5a"
       url: "https://pub.dev"
     source: hosted
-    version: "0.5.0"
+    version: "0.8.0"
   meta:
     dependency: transitive
     description:
       name: meta
-      sha256: a6e590c838b18133bb482a2745ad77c5bb7715fb0451209e1a7567d416678b8e
+      sha256: d584fa6707a52763a52446f02cc621b077888fb63b93bbcb1143a7be5a0c0c04
       url: "https://pub.dev"
     source: hosted
-    version: "1.10.0"
+    version: "1.11.0"
   mime:
     dependency: transitive
     description:
@@ -535,14 +535,6 @@ packages:
       url: "https://pub.dev"
     source: hosted
     version: "1.1.0"
-  web:
-    dependency: transitive
-    description:
-      name: web
-      sha256: afe077240a270dcfd2aafe77602b4113645af95d0ad31128cc02bce5ac5d5152
-      url: "https://pub.dev"
-    source: hosted
-    version: "0.3.0"
   web_socket_channel:
     dependency: transitive
     description:
@@ -569,4 +561,4 @@ packages:
     version: "3.1.2"
 sdks:
   dart: ">=3.2.0 <4.0.0"
-  flutter: ">=3.13.0"
+  flutter: ">=3.19.0"

lib/base/base_game.dart

@@ -107,7 +107,7 @@ abstract class BaseGame extends FlameGame
 
   @override
   KeyEventResult onKeyEvent(
-    RawKeyEvent event,
+    KeyEvent event,
     Set<LogicalKeyboardKey> keysPressed,
   ) {
     if (!enabledKeyboard) {

lib/base/bonfire_game.dart

@@ -108,6 +108,7 @@ class BonfireGame extends BaseGame implements BonfireGameInterface {
     this.player,
     this.interface,
     List<GameComponent>? components,
+    List<GameComponent>? hudComponents,
     this.background,
     bool debugMode = false,
     this.showCollisionArea = false,
@@ -138,6 +139,7 @@ class BonfireGame extends BaseGame implements BonfireGameInterface {
                 keyboardConfig: keyboardConfig,
               ),
               if (interface != null) interface,
+              ...hudComponents ?? []
             ],
           ),
           world: World(
@@ -312,7 +314,6 @@ class BonfireGame extends BaseGame implements BonfireGameInterface {
   @override
   void onDetach() {
     _notifyGameDetach();
-    FollowerWidget.removeAll();
     super.onDetach();
   }
 
@@ -473,6 +474,7 @@ class BonfireGame extends BaseGame implements BonfireGameInterface {
   }
 
   void _notifyGameDetach() {
+    FollowerWidget.removeAll();
     void gameDetachComp(GameComponent c) => c.onGameDetach();
     query<GameComponent>().forEach(gameDetachComp);
     for (var child in camera.children) {
@@ -485,4 +487,14 @@ class BonfireGame extends BaseGame implements BonfireGameInterface {
 
   @override
   Vector2 get worldsize => map.size;
+
+  @override
+  Iterable<T> queryHud<T extends Component>() {
+    return camera.viewport.children.query<T>();
+  }
+
+  @override
+  FutureOr<void> addHud(Component component) {
+    return camera.viewport.add(component);
+  }
 }

lib/base/bonfire_game_interface.dart

@@ -97,10 +97,10 @@ abstract class BonfireGameInterface {
   Iterable<T> query<T extends Component>({bool onlyVisible = false});
 
   /// This  method convert word position to screen position
-  Vector2 worldToScreen(Vector2 position);
+  Vector2 worldToScreen(Vector2 worldPosition);
 
   /// This  method convert screen position to word position
-  Vector2 screenToWorld(Vector2 position);
+  Vector2 screenToWorld(Vector2 screenPosition);
 
   /// Used to check if a component is visible in the camera.
   bool isVisibleInCamera(GameComponent c);
@@ -112,6 +112,12 @@ abstract class BonfireGameInterface {
     bool moveCameraToTarget = false,
   });
 
+  /// Used to get hud components.
+  Iterable<T> queryHud<T extends Component>();
+
+  /// Used to add hud component in the game.
+  FutureOr<void> addHud(Component component);
+
   RaycastResult<ShapeHitbox>? raycast(
     Ray2 ray, {
     double? maxDistance,

lib/base/listener_game_widget.dart

@@ -294,15 +294,18 @@ class ListenerGameWidgetState<T extends Game>
     }
   }
 
-  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;
   }
@@ -364,7 +367,7 @@ class ListenerGameWidgetState<T extends Game>
               focusNode: _focusNode,
               autofocus: widget.autofocus,
               descendantsAreFocusable: true,
-              onKey: _handleKeyEvent,
+              onKeyEvent: _handleKeyEvent,
               child: MouseRegion(
                 cursor: currentGame.mouseCursor,
                 child: Directionality(

lib/color_filter/color_filter_component.dart

@@ -36,10 +36,7 @@ class ColorFilterComponent extends GameComponent
 
   @override
   int get priority {
-    if (hasGameRef) {
-      return LayerPriority.getColorFilterPriority(gameRef.highestPriority);
-    }
-    return super.priority;
+    return LayerPriority.getHudColorFilterPriority();
   }
 
   @override

lib/game_interface/game_interface.dart

@@ -6,10 +6,7 @@ import 'package:bonfire/bonfire.dart';
 class GameInterface extends GameComponent {
   @override
   int get priority {
-    if (hasGameRef) {
-      return LayerPriority.getInterfacePriority(gameRef.highestPriority);
-    }
-    return super.priority;
+    return LayerPriority.getHudInterfacePriority();
   }
 
   /// Used to add components in your interface like a Button.

lib/input/keyboard/control_by_keyboard.dart

@@ -15,7 +15,7 @@ class ControlByKeyboard extends PlayerController with KeyboardEventListener {
   }
 
   @override
-  bool onKeyboard(RawKeyEvent event, Set<LogicalKeyboardKey> keysPressed) {
+  bool onKeyboard(KeyEvent event, Set<LogicalKeyboardKey> keysPressed) {
     /// If the keyboard is disabled, we do not process the event
     if (!keyboardConfig.enable) return false;
 
@@ -28,7 +28,7 @@ class ControlByKeyboard extends PlayerController with KeyboardEventListener {
 
     /// No keyboard events, keep idle
     if (!_containDirectionalPressed(keysPressed) &&
-        !event.repeat &&
+        !event.synthesized &&
         !_directionalIsIdle) {
       _directionalIsIdle = true;
       joystickChangeDirectional(
@@ -57,14 +57,14 @@ class ControlByKeyboard extends PlayerController with KeyboardEventListener {
       }
     } else {
       /// Process action events
-      if (event is RawKeyDownEvent) {
+      if (event is KeyDownEvent) {
         joystickAction(
           JoystickActionEvent(
             id: event.logicalKey,
             event: ActionEvent.DOWN,
           ),
         );
-      } else if (event is RawKeyUpEvent) {
+      } else if (event is KeyUpEvent) {
         joystickAction(
           JoystickActionEvent(
             id: event.logicalKey,

lib/input/keyboard/keyboard_listener.dart

@@ -4,7 +4,7 @@ import 'package:flutter/services.dart';
 mixin KeyboardEventListener on GameComponent {
   // If return 'true' this event is not relay to others components.
   bool onKeyboard(
-    RawKeyEvent event,
+    KeyEvent event,
     Set<LogicalKeyboardKey> keysPressed,
   ) {
     return false;

lib/input/player_controller.dart

@@ -51,8 +51,15 @@ mixin PlayerControllerListener {
 }
 
 abstract class PlayerController extends GameComponent {
+  final dynamic id;
   final List<PlayerControllerListener> _observers = [];
 
+  PlayerController({this.id, PlayerControllerListener? observer}) {
+    if (observer != null) {
+      _observers.add(observer);
+    }
+  }
+
   void joystickChangeDirectional(JoystickDirectionalEvent event) {
     for (var o in _observers) {
       o.onJoystickChangeDirectional(event);
@@ -83,10 +90,7 @@ abstract class PlayerController extends GameComponent {
 
   @override
   int get priority {
-    if (hasGameRef) {
-      return LayerPriority.getJoystickPriority(gameRef.highestPriority);
-    }
-    return super.priority;
+    return LayerPriority.getHudJoystickPriority();
   }
 
   @override

lib/lighting/lighting_component.dart

@@ -30,10 +30,7 @@ class LightingComponent extends GameComponent implements LightingInterface {
 
   @override
   int get priority {
-    if (hasGameRef) {
-      return LayerPriority.getLightingPriority(gameRef.highestPriority);
-    }
-    return super.priority;
+    return LayerPriority.getHudLightingPriority();
   }
 
   Path getWheelPath(double wheelSize, double fromRadius, double toRadius) {

lib/util/priority_layer.dart

@@ -10,22 +10,22 @@ class LayerPriority {
   }
 
   static int getAbovePriority(int highestPriority) {
-    return highestPriority + 5;
+    return highestPriority + 10;
   }
 
-  static int getLightingPriority(int highestPriority) {
-    return highestPriority + 10;
+  static int getHudLightingPriority() {
+    return 10;
   }
 
-  static int getColorFilterPriority(int highestPriority) {
-    return highestPriority + 20;
+  static int getHudColorFilterPriority() {
+    return 20;
   }
 
-  static int getInterfacePriority(int highestPriority) {
-    return highestPriority + 30;
+  static int getHudInterfacePriority() {
+    return 30;
   }
 
-  static int getJoystickPriority(int highestPriority) {
-    return highestPriority + 40;
+  static int getHudJoystickPriority() {
+    return 40;
   }
 }

lib/util/talk/talk_dialog.dart

@@ -103,17 +103,17 @@ class TalkDialogState extends State<TalkDialog> {
   Widget build(BuildContext context) {
     return Material(
       type: MaterialType.transparency,
-      child: RawKeyboardListener(
+      child: KeyboardListener(
         focusNode: _focusNode,
-        onKey: (raw) {
-          if (widget.keyboardKeysToNext.isEmpty && raw is RawKeyDownEvent) {
+        onKeyEvent: (raw) {
+          if (widget.keyboardKeysToNext.isEmpty && raw is KeyDownEvent) {
             // Prevent volume buttons from triggering the next dialog
             if (raw.logicalKey != LogicalKeyboardKey.audioVolumeUp &&
                 raw.logicalKey != LogicalKeyboardKey.audioVolumeDown) {
               _nextOrFinish();
             }
           } else if (widget.keyboardKeysToNext.contains(raw.logicalKey) &&
-              raw is RawKeyDownEvent) {
+              raw is KeyDownEvent) {
             _nextOrFinish();
           }
         },