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
This commit is contained in:
Lukas Klingsbo
2021-11-19 14:28:04 +01:00
committed by GitHub
parent 904481d289
commit 8b132d7c0b
90 changed files with 1574 additions and 1140 deletions

View File

@ -2,56 +2,28 @@ import 'package:dashbook/dashbook.dart';
import 'package:flame/game.dart';
import '../../commons/commons.dart';
import 'animation_group.dart';
import 'aseprite.dart';
import 'basic.dart';
const basicInfo = '''
Basic example of `SpriteAnimation`s use in Flame's `FlameGame`
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
''';
import 'animation_group_example.dart';
import 'aseprite_example.dart';
import 'basic_animation_example.dart';
void addAnimationStories(Dashbook dashbook) {
dashbook.storiesOf('Animations')
..add(
'Basic Animations',
(_) => GameWidget(game: BasicAnimations()),
codeLink: baseLink('animations/basic.dart'),
info: basicInfo,
(_) => GameWidget(game: BasicAnimationsExample()),
codeLink: baseLink('animations/basic_animation_example.dart'),
info: BasicAnimationsExample.description,
)
..add(
'Group animation',
(_) => GameWidget(game: AnimationGroupExample()),
codeLink: baseLink('animations/aseprite.dart'),
codeLink: baseLink('animations/aseprite_example.dart'),
info: AnimationGroupExample.description,
)
..add(
'Aseprite',
(_) => GameWidget(game: Aseprite()),
codeLink: baseLink('animations/aseprite.dart'),
(_) => GameWidget(game: AsepriteExample()),
codeLink: baseLink('animations/aseprite_example.dart'),
info: AsepriteExample.description,
);
}