Unify examples structure (#1118)

* Animations, CameraAndViewport, CollisionDetection and Components unified * Added descriptions to effects * Rename input games * Unify input stories * Add info to parallax section * Added descriptions to the rendering examples * Add descriptions to the sprites directory * Fix utils and rendering section * Add descriptions to the widgets section * Delete directory that rebase brought back * Unify game names * Added some styleguide docs for examples * Fix analyze issues * All files should have _example as suffix * Made the FollowComponentExample a bit easier to understand * Change priority of ember
2025-10-31 17:06:50 +08:00 · 2021-11-19 14:28:04 +01:00
parent 904481d289
commit 8b132d7c0b
90 changed files with 1574 additions and 1140 deletions
--- a/examples/lib/stories/animations/basic_animation_example.dart
+++ b/examples/lib/stories/animations/basic_animation_example.dart
@ -0,0 +1,101 @@
+import 'dart:ui';
+
+import 'package:flame/components.dart';
+import 'package:flame/game.dart';
+import 'package:flame/input.dart';
+
+import '../../commons/ember.dart';
+
+class BasicAnimationsExample extends FlameGame with TapDetector {
+  static const description = '''
+    Basic example of `SpriteAnimation`s use in Flame's `FlameGame`\n\n
+    
+    The snippet shows how an animation can be loaded and added to the game
+    ```
+    class MyGame extends FlameGame {
+      @override
+      Future<void> onLoad() async {
+        final animation = await loadSpriteAnimation(
+          'animations/chopper.png',
+          SpriteAnimationData.sequenced(
+            amount: 4,
+            textureSize: Vector2.all(48),
+            stepTime: 0.15,
+          ),
+        );
+    
+        final animationComponent = SpriteAnimationComponent(
+          animation: animation,
+          size: Vector2.all(100.0),
+        );
+    
+        add(animationComponent);
+      }
+    }
+    ```
+
+    On this example, click or touch anywhere on the screen to dynamically add
+    animations.
+  ''';
+
+  late Image creature;
+
+  @override
+  Future<void> onLoad() async {
+    await super.onLoad();
+    creature = await images.load('animations/creature.png');
+
+    final animation = await loadSpriteAnimation(
+      'animations/chopper.png',
+      SpriteAnimationData.sequenced(
+        amount: 4,
+        textureSize: Vector2.all(48),
+        stepTime: 0.15,
+      ),
+    );
+
+    final spriteSize = Vector2.all(100.0);
+    final animationComponent = SpriteAnimationComponent(
+      animation: animation,
+      size: spriteSize,
+    );
+    animationComponent.x = size.x / 2 - spriteSize.x;
+    animationComponent.y = spriteSize.y;
+
+    final reversedAnimationComponent = SpriteAnimationComponent(
+      animation: animation.reversed(),
+      size: spriteSize,
+    );
+    reversedAnimationComponent.x = size.x / 2;
+    reversedAnimationComponent.y = spriteSize.y;
+
+    add(animationComponent);
+    add(reversedAnimationComponent);
+    add(Ember()..position = size / 2);
+  }
+
+  void addAnimation(Vector2 position) {
+    final size = Vector2(291, 178);
+
+    final animationComponent = SpriteAnimationComponent.fromFrameData(
+      creature,
+      SpriteAnimationData.sequenced(
+        amount: 18,
+        amountPerRow: 10,
+        textureSize: size,
+        stepTime: 0.15,
+        loop: false,
+      ),
+      size: size,
+      removeOnFinish: true,
+    );
+
+    animationComponent.position = position - size / 2;
+    add(animationComponent);
+  }
+
+  @override
+  void onTapDown(TapDownInfo info) {
+    addAnimation(info.eventPosition.game);
+  }
+}