fix: Change return type of RiverpodComponentMixin.onLoad to FutureOr<…

…void> (#2964)

This PR changes the return type of RiverpodComponentMixin.onLoad to
match that of Component.onLoad.

This resolves #2961 which describes an error preventing use of
RiverpodComponentMixin on Component subclasses that return a Future in
their implementation of onLoad due to a signature mismatch.


Closes #2961.

---------

Co-authored-by: Lukas Klingsbo <lukas.klingsbo@gmail.com>

.github/.cspell/gamedev_dictionary.txt

@@ -6,7 +6,6 @@ AHSV # alpha hue saturation value
 antialiasing # set of techniques to combat the problems of aliasing
 ARGB # alpha red green blue
 arities # plural of arity
-arity # number of parameters a function takes
 autofocus # auto focus event
 backgrounded # moving the app to the background
 backgrounding # moving the app to the background

packages/flame_riverpod/lib/src/consumer.dart

@@ -1,3 +1,4 @@
+import 'dart:async';
 import 'package:flame/components.dart';
 import 'package:flame/game.dart';
 import 'package:flame_riverpod/src/widget.dart';
@@ -80,7 +81,7 @@ mixin RiverpodComponentMixin on Component {
 
  @mustCallSuper
  @override
- void onLoad() {
+ FutureOr<void> onLoad() {
  ref.game = findGame()! as RiverpodGameMixin;
  super.onLoad();
  }