mirror of
https://github.com/flame-engine/flame.git
synced 2025-10-31 08:56:01 +08:00
d898b539f7
Before this PR, the return type of onLoad() was Future<void>?, after this PR the return type is FutureOr<void> -- both for classes Component and Game.
Reasons:
The use of FutureOr is more idiomatic in Dart, this class was specifically created in order to be used in situations like ours.
This makes learning Flame easier for beginners, since you no longer need to explain what asynchronous programming is from the start (and onLoad() is one of the first methods the user encounters in Flame).
The code can be cleaner in case when onLoad doesn't need to be async.
With new approach, the onLoad() method can be overridden as either
@override
Future<void> onLoad() async { ... }
or
@override
void onLoad() { ... }
Of course, it can also be overridden as
@override
FutureOr<void> onLoad() { ... }
but this is rare, only for components that are designed to be further subclassed, or for mixins.
The documentation was updated to show the new recommended usage.
75 lines
1.6 KiB
Dart
75 lines
1.6 KiB
Dart
import 'package:flame/components.dart';
|
|
import 'package:flame/game.dart';
|
|
import 'package:flame/input.dart';
|
|
import 'package:flame_rive/flame_rive.dart';
|
|
import 'package:flutter/material.dart';
|
|
|
|
void main() {
|
|
runApp(const MyApp());
|
|
}
|
|
|
|
class MyApp extends StatefulWidget {
|
|
const MyApp({super.key});
|
|
|
|
@override
|
|
State<MyApp> createState() => _MyAppState();
|
|
}
|
|
|
|
class _MyAppState extends State<MyApp> {
|
|
late final game = RiveExampleGame();
|
|
|
|
@override
|
|
Widget build(BuildContext context) {
|
|
return GameWidget(
|
|
game: game,
|
|
);
|
|
}
|
|
}
|
|
|
|
class RiveExampleGame extends FlameGame with HasTappables {
|
|
@override
|
|
Color backgroundColor() {
|
|
return const Color(0xFFFFFFFF);
|
|
}
|
|
|
|
@override
|
|
Future<void> onLoad() async {
|
|
final skillsArtboard =
|
|
await loadArtboard(RiveFile.asset('assets/skills.riv'));
|
|
add(SkillsAnimationComponent(skillsArtboard));
|
|
}
|
|
}
|
|
|
|
class SkillsAnimationComponent extends RiveComponent with Tappable {
|
|
SkillsAnimationComponent(Artboard artboard)
|
|
: super(
|
|
artboard: artboard,
|
|
size: Vector2.all(550),
|
|
);
|
|
|
|
SMIInput<double>? _levelInput;
|
|
|
|
@override
|
|
void onLoad() {
|
|
final controller = StateMachineController.fromArtboard(
|
|
artboard,
|
|
"Designer's Test",
|
|
);
|
|
if (controller != null) {
|
|
artboard.addController(controller);
|
|
_levelInput = controller.findInput<double>('Level');
|
|
_levelInput?.value = 0;
|
|
}
|
|
}
|
|
|
|
@override
|
|
bool onTapDown(TapDownInfo info) {
|
|
final levelInput = _levelInput;
|
|
if (levelInput == null) {
|
|
return false;
|
|
}
|
|
levelInput.value = (levelInput.value + 1) % 3;
|
|
return true;
|
|
}
|
|
}
|