Merge pull request #16 from VGVentures/doc/wall-docs

docs: adding dart docs to the wall component
pull/21/head
Erick 3 years ago committed by GitHub
commit 0b9a0c2c6a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -3,6 +3,9 @@
import 'package:flame_forge2d/flame_forge2d.dart'; import 'package:flame_forge2d/flame_forge2d.dart';
import 'package:pinball/game/components/components.dart'; import 'package:pinball/game/components/components.dart';
/// {@template wall}
/// A continuos generic and [BodyType.static] barrier that divides a game area.
/// {@endtemplate}
class Wall extends BodyComponent { class Wall extends BodyComponent {
Wall({ Wall({
required this.start, required this.start,
@ -29,6 +32,12 @@ class Wall extends BodyComponent {
} }
} }
/// {@template bottom_wall}
/// [Wall] located at the bottom of the board.
///
/// Collisions with [BottomWall] are listened by
/// [BottomWallBallContactCallback].
/// {@endtemplate}
class BottomWall extends Wall { class BottomWall extends Wall {
BottomWall(Forge2DGame game) BottomWall(Forge2DGame game)
: super( : super(
@ -40,6 +49,9 @@ class BottomWall extends Wall {
); );
} }
/// {@template bottom_wall_ball_contact_callback}
/// Listens when a [Ball] falls into a [BottomWall].
/// {@endtemplate}
class BottomWallBallContactCallback extends ContactCallback<Ball, BottomWall> { class BottomWallBallContactCallback extends ContactCallback<Ball, BottomWall> {
@override @override
void begin(Ball ball, BottomWall wall, Contact contact) { void begin(Ball ball, BottomWall wall, Contact contact) {

Loading…
Cancel
Save