add more doc

CHANGELOG.md

@@ -5,6 +5,7 @@
 - Check if chidren are loaded before rendering on ComposedComponent (thanks @wenxiangjiang)
 - Amend type for width and height properties on Animation.sequenced (thanks @wenxiangjiang)
 - Fixing Tapable position checking
+- Support line feed when create animation from a single image source
 
 ## 0.18.1
 - Expose stepTime paramter from the Animation class to the animation component

doc/examples/animations/lib/main.dart

@@ -6,6 +6,7 @@ import 'package:flame/components/animation_component.dart';
 import 'package:flutter/material.dart';
 
 void main() async {
+  WidgetsFlutterBinding.ensureInitialized();
   final Size size = await Flame.util.initialDimensions();
   final game = MyGame(size);
   runApp(game.widget);
@@ -21,10 +22,11 @@ class MyGame extends BaseGame {
       textureWidth: 48, textureHeight: 48, stepTime: 0.15);
 
   void addAnimation() {
-    final animationComponent =
-        AnimationComponent(100, 100, animation, destroyOnFinish: true);
-    animationComponent.x = size.width / 2 - 50;
-    animationComponent.y = 200;
+    final animationComponent = AnimationComponent.sequenced(291, 178, 'creture.png', 18,
+        amountPerRow: 10, textureWidth: 291, textureHeight: 178, stepTime: 0.15,
+        loop: false, destroyOnFinish: true);
+    animationComponent.x = (size.width - 291) / 2;
+    animationComponent.y = 250;
 
     add(animationComponent);
   }

doc/examples/animations/pubspec.yaml

@@ -19,3 +19,4 @@ dev_dependencies:
 flutter:
   assets:
     - assets/images/chopper.png
+    - assets/images/creture.png

lib/animation.dart

@@ -55,7 +55,9 @@ class Animation {
   ///
   /// From a single image source, it creates multiple sprites based on the parameters:
   /// [amount]: how many sprites this animation is composed of
-  /// [amountPerRow]: how many sprites per row
+  /// [amountPerRow]: If the sprites used to create a animation are not on the same row,
+  ///     you can use this parameter to specify how many sprites per row.
+  ///     For detailed, please refer to example at "/doc/examples/animations".
   /// [textureX]: x position on the original image to start (defaults to 0)
   /// [textureY]: y position on the original image to start (defaults to 0)
   /// [textureWidth]: width of each frame (defaults to null, that is, full width of the sprite sheet)