diff --git a/assets/images/components/flipper.png b/assets/images/components/flipper.png deleted file mode 100644 index f63974c4..00000000 Binary files a/assets/images/components/flipper.png and /dev/null differ diff --git a/lib/game/components/baseboard.dart b/lib/game/components/baseboard.dart index d4c326e3..cdad23fc 100644 --- a/lib/game/components/baseboard.dart +++ b/lib/game/components/baseboard.dart @@ -1,7 +1,6 @@ import 'dart:math' as math; import 'package:flame_forge2d/flame_forge2d.dart'; -import 'package:pinball/game/game.dart'; import 'package:pinball_components/pinball_components.dart'; /// {@template baseboard} diff --git a/lib/game/components/board.dart b/lib/game/components/board.dart index 1f96120e..84e6758d 100644 --- a/lib/game/components/board.dart +++ b/lib/game/components/board.dart @@ -1,5 +1,6 @@ import 'package:flame/components.dart'; import 'package:pinball/game/game.dart'; +import 'package:pinball_components/pinball_components.dart'; /// {@template board} /// The main flat surface of the [PinballGame]. @@ -95,12 +96,15 @@ class _BottomGroupSide extends Component { final flipper = Flipper( side: _side, )..initialPosition = _position; + await flipper.add(FlipperController(flipper)); + final baseboard = Baseboard(side: _side) ..initialPosition = _position + Vector2( (Baseboard.size.x / 1.6 * direction), Baseboard.size.y - 2, ); + final kicker = Kicker( side: _side, )..initialPosition = _position + diff --git a/lib/game/components/chrome_dino.dart b/lib/game/components/chrome_dino.dart index 5cf39b3c..dc280350 100644 --- a/lib/game/components/chrome_dino.dart +++ b/lib/game/components/chrome_dino.dart @@ -4,7 +4,6 @@ import 'dart:math' as math; import 'package:flame/components.dart'; import 'package:flame_forge2d/flame_forge2d.dart' hide Timer; import 'package:flutter/material.dart'; -import 'package:pinball/game/game.dart'; import 'package:pinball_components/pinball_components.dart'; /// {@template chrome_dino} diff --git a/lib/game/components/components.dart b/lib/game/components/components.dart index 7c3347a6..d02063c9 100644 --- a/lib/game/components/components.dart +++ b/lib/game/components/components.dart @@ -1,13 +1,11 @@ export 'ball.dart'; export 'baseboard.dart'; export 'board.dart'; -export 'board_side.dart'; export 'bonus_word.dart'; export 'chrome_dino.dart'; -export 'flipper.dart'; +export 'flipper_controller.dart'; export 'flutter_forest.dart'; export 'jetpack_ramp.dart'; -export 'joint_anchor.dart'; export 'kicker.dart'; export 'launcher_ramp.dart'; export 'plunger.dart'; diff --git a/lib/game/components/flipper_controller.dart b/lib/game/components/flipper_controller.dart new file mode 100644 index 00000000..946cfd49 --- /dev/null +++ b/lib/game/components/flipper_controller.dart @@ -0,0 +1,52 @@ +import 'package:flame/components.dart'; +import 'package:flutter/services.dart'; +import 'package:pinball_components/pinball_components.dart'; + +/// {@template flipper_controller} +/// A [Component] that controls the [Flipper]s movement. +/// {@endtemplate} +class FlipperController extends Component with KeyboardHandler { + /// {@macro flipper_controller} + FlipperController(this.flipper) : _keys = flipper.side.flipperKeys; + + /// The [Flipper] this controller is controlling. + final Flipper flipper; + + /// The [LogicalKeyboardKey]s that will control the [Flipper]. + /// + /// [onKeyEvent] method listens to when one of these keys is pressed. + final List _keys; + + @override + bool onKeyEvent( + RawKeyEvent event, + Set keysPressed, + ) { + if (!_keys.contains(event.logicalKey)) return true; + + if (event is RawKeyDownEvent) { + flipper.moveUp(); + } else if (event is RawKeyUpEvent) { + flipper.moveDown(); + } + + return false; + } +} + +extension on BoardSide { + List get flipperKeys { + switch (this) { + case BoardSide.left: + return [ + LogicalKeyboardKey.arrowLeft, + LogicalKeyboardKey.keyA, + ]; + case BoardSide.right: + return [ + LogicalKeyboardKey.arrowRight, + LogicalKeyboardKey.keyD, + ]; + } + } +} diff --git a/lib/game/components/kicker.dart b/lib/game/components/kicker.dart index dc55a52f..d9eb7932 100644 --- a/lib/game/components/kicker.dart +++ b/lib/game/components/kicker.dart @@ -4,7 +4,6 @@ import 'package:flame/extensions.dart'; import 'package:flame_forge2d/flame_forge2d.dart'; import 'package:flutter/material.dart'; import 'package:geometry/geometry.dart' as geometry show centroid; -import 'package:pinball/game/game.dart'; import 'package:pinball_components/pinball_components.dart'; /// {@template kicker} diff --git a/lib/game/game_assets.dart b/lib/game/game_assets.dart index 648532cf..47e41393 100644 --- a/lib/game/game_assets.dart +++ b/lib/game/game_assets.dart @@ -8,7 +8,8 @@ extension PinballGameAssetsX on PinballGame { Future preLoadAssets() async { await Future.wait([ images.load(components.Assets.images.ball.keyName), - images.load(Assets.images.components.flipper.path), + images.load(components.Assets.images.flipper.left.keyName), + images.load(components.Assets.images.flipper.right.keyName), images.load(Assets.images.components.background.path), images.load(Assets.images.components.spaceship.androidTop.path), images.load(Assets.images.components.spaceship.androidBottom.path), diff --git a/lib/gen/assets.gen.dart b/lib/gen/assets.gen.dart index 8c228e16..14f0e632 100644 --- a/lib/gen/assets.gen.dart +++ b/lib/gen/assets.gen.dart @@ -21,10 +21,6 @@ class $AssetsImagesComponentsGen { AssetGenImage get background => const AssetGenImage('assets/images/components/background.png'); - /// File path: assets/images/components/flipper.png - AssetGenImage get flipper => - const AssetGenImage('assets/images/components/flipper.png'); - $AssetsImagesComponentsSpaceshipGen get spaceship => const $AssetsImagesComponentsSpaceshipGen(); } diff --git a/packages/pinball_components/assets/images/flipper/left.png b/packages/pinball_components/assets/images/flipper/left.png new file mode 100644 index 00000000..42798f28 Binary files /dev/null and b/packages/pinball_components/assets/images/flipper/left.png differ diff --git a/packages/pinball_components/assets/images/flipper/right.png b/packages/pinball_components/assets/images/flipper/right.png new file mode 100644 index 00000000..86fbc81d Binary files /dev/null and b/packages/pinball_components/assets/images/flipper/right.png differ diff --git a/packages/pinball_components/lib/gen/assets.gen.dart b/packages/pinball_components/lib/gen/assets.gen.dart index c4ed6ca0..c61923c3 100644 --- a/packages/pinball_components/lib/gen/assets.gen.dart +++ b/packages/pinball_components/lib/gen/assets.gen.dart @@ -3,12 +3,29 @@ /// FlutterGen /// ***************************************************** +// ignore_for_file: directives_ordering,unnecessary_import + import 'package:flutter/widgets.dart'; class $AssetsImagesGen { const $AssetsImagesGen(); + /// File path: assets/images/ball.png AssetGenImage get ball => const AssetGenImage('assets/images/ball.png'); + + $AssetsImagesFlipperGen get flipper => const $AssetsImagesFlipperGen(); +} + +class $AssetsImagesFlipperGen { + const $AssetsImagesFlipperGen(); + + /// File path: assets/images/flipper/left.png + AssetGenImage get left => + const AssetGenImage('assets/images/flipper/left.png'); + + /// File path: assets/images/flipper/right.png + AssetGenImage get right => + const AssetGenImage('assets/images/flipper/right.png'); } class Assets { diff --git a/packages/pinball_components/lib/src/components/ball.dart b/packages/pinball_components/lib/src/components/ball.dart index 2ceb56d7..9a2da898 100644 --- a/packages/pinball_components/lib/src/components/ball.dart +++ b/packages/pinball_components/lib/src/components/ball.dart @@ -6,7 +6,7 @@ import 'package:flame_forge2d/flame_forge2d.dart'; import 'package:pinball_components/pinball_components.dart'; /// {@template ball} -/// A solid, [BodyType.dynamic] sphere that rolls and bounces around +/// A solid, [BodyType.dynamic] sphere that rolls and bounces around. /// {@endtemplate} class Ball extends BodyComponent with Layered, InitialPosition { @@ -90,7 +90,7 @@ class Ball extends BodyComponent } } - /// Applies a boost on this [Ball] + /// Applies a boost on this [Ball]. void boost(Vector2 impulse) { body.applyLinearImpulse(impulse); _boostTimer = _boostDuration; diff --git a/lib/game/components/board_side.dart b/packages/pinball_components/lib/src/components/board_side.dart similarity index 77% rename from lib/game/components/board_side.dart rename to packages/pinball_components/lib/src/components/board_side.dart index 2ef8d651..ac530567 100644 --- a/lib/game/components/board_side.dart +++ b/packages/pinball_components/lib/src/components/board_side.dart @@ -1,4 +1,8 @@ -import 'package:pinball/game/game.dart'; +// ignore_for_file: comment_references +// TODO(alestiago): Revisit ignore lint rule once Kicker is moved to this +// package. + +import 'package:pinball_components/pinball_components.dart'; /// Indicates a side of the board. /// diff --git a/packages/pinball_components/lib/src/components/components.dart b/packages/pinball_components/lib/src/components/components.dart index a55f9566..185ac25f 100644 --- a/packages/pinball_components/lib/src/components/components.dart +++ b/packages/pinball_components/lib/src/components/components.dart @@ -1,5 +1,8 @@ export 'ball.dart'; +export 'board_side.dart'; export 'fire_effect.dart'; +export 'flipper.dart'; export 'initial_position.dart'; +export 'joint_anchor.dart'; export 'layer.dart'; export 'shapes/shapes.dart'; diff --git a/lib/game/components/flipper.dart b/packages/pinball_components/lib/src/components/flipper.dart similarity index 70% rename from lib/game/components/flipper.dart rename to packages/pinball_components/lib/src/components/flipper.dart index 6e64c781..de5f18c8 100644 --- a/lib/game/components/flipper.dart +++ b/packages/pinball_components/lib/src/components/flipper.dart @@ -3,20 +3,7 @@ import 'dart:math' as math; import 'package:flame/components.dart'; import 'package:flame_forge2d/flame_forge2d.dart'; -import 'package:flutter/services.dart'; -import 'package:pinball/game/game.dart'; -import 'package:pinball/gen/assets.gen.dart'; -import 'package:pinball_components/pinball_components.dart' hide Assets; - -const _leftFlipperKeys = [ - LogicalKeyboardKey.arrowLeft, - LogicalKeyboardKey.keyA, -]; - -const _rightFlipperKeys = [ - LogicalKeyboardKey.arrowRight, - LogicalKeyboardKey.keyD, -]; +import 'package:pinball_components/pinball_components.dart'; /// {@template flipper} /// A bat, typically found in pairs at the bottom of the board. @@ -27,10 +14,10 @@ class Flipper extends BodyComponent with KeyboardHandler, InitialPosition { /// {@macro flipper} Flipper({ required this.side, - }) : _keys = side.isLeft ? _leftFlipperKeys : _rightFlipperKeys; + }); /// The size of the [Flipper]. - static final size = Vector2(12, 2.8); + static final size = Vector2(13.5, 4.3); /// The speed required to move the [Flipper] to its highest position. /// @@ -43,27 +30,24 @@ class Flipper extends BodyComponent with KeyboardHandler, InitialPosition { /// whereas a [Flipper] with [BoardSide.right] has a clockwise arc motion. final BoardSide side; - /// The [LogicalKeyboardKey]s that will control the [Flipper]. - /// - /// [onKeyEvent] method listens to when one of these keys is pressed. - final List _keys; - /// Applies downward linear velocity to the [Flipper], moving it to its /// resting position. - void _moveDown() { + void moveDown() { body.linearVelocity = Vector2(0, -_speed); } /// Applies upward linear velocity to the [Flipper], moving it to its highest /// position. - void _moveUp() { + void moveUp() { body.linearVelocity = Vector2(0, _speed); } /// Loads the sprite that renders with the [Flipper]. Future _loadSprite() async { final sprite = await gameRef.loadSprite( - Assets.images.components.flipper.path, + (side.isLeft) + ? Assets.images.flipper.left.keyName + : Assets.images.flipper.right.keyName, ); final spriteComponent = SpriteComponent( sprite: sprite, @@ -71,10 +55,6 @@ class Flipper extends BodyComponent with KeyboardHandler, InitialPosition { anchor: Anchor.center, ); - if (side.isRight) { - spriteComponent.flipHorizontally(); - } - await add(spriteComponent); } @@ -87,30 +67,36 @@ class Flipper extends BodyComponent with KeyboardHandler, InitialPosition { flipper: this, anchor: anchor, ); - final joint = _FlipperJoint(jointDef)..create(world); - - // FIXME(erickzanardo): when mounted the initial position is not fully - // reached. - unawaited( - mounted.whenComplete(joint.unlock), - ); + final joint = _FlipperJoint(jointDef); + world.createJoint2(joint); + unawaited(mounted.whenComplete(joint.unlock)); } List _createFixtureDefs() { final fixturesDef = []; final direction = side.direction; - final bigCircleShape = CircleShape()..radius = 1.75; + final assetShadow = Flipper.size.x * 0.012 * -direction; + final size = Vector2( + Flipper.size.x - (assetShadow * 2), + Flipper.size.y, + ); + + final bigCircleShape = CircleShape()..radius = size.y / 2 - 0.2; bigCircleShape.position.setValues( - ((size.x / 2) * direction) + (bigCircleShape.radius * -direction), + ((size.x / 2) * direction) + + (bigCircleShape.radius * -direction) + + assetShadow, 0, ); final bigCircleFixtureDef = FixtureDef(bigCircleShape); fixturesDef.add(bigCircleFixtureDef); - final smallCircleShape = CircleShape()..radius = 0.9; + final smallCircleShape = CircleShape()..radius = size.y * 0.23; smallCircleShape.position.setValues( - ((size.x / 2) * -direction) + (smallCircleShape.radius * direction), + ((size.x / 2) * -direction) + + (smallCircleShape.radius * direction) - + assetShadow, 0, ); final smallCircleFixtureDef = FixtureDef(smallCircleShape); @@ -143,7 +129,7 @@ class Flipper extends BodyComponent with KeyboardHandler, InitialPosition { await super.onLoad(); renderBody = false; - await Future.wait([ + await Future.wait([ _loadSprite(), _anchorToJoint(), ]); @@ -160,22 +146,6 @@ class Flipper extends BodyComponent with KeyboardHandler, InitialPosition { return body; } - - @override - bool onKeyEvent( - RawKeyEvent event, - Set keysPressed, - ) { - if (!_keys.contains(event.logicalKey)) return true; - - if (event is RawKeyDownEvent) { - _moveUp(); - } else if (event is RawKeyUpEvent) { - _moveDown(); - } - - return false; - } } /// {@template flipper_anchor} @@ -204,45 +174,60 @@ class _FlipperAnchorRevoluteJointDef extends RevoluteJointDef { required Flipper flipper, required _FlipperAnchor anchor, }) : side = flipper.side { + enableLimit = true; initialize( flipper.body, anchor.body, anchor.body.position, ); - - enableLimit = true; - final angle = (_sweepingAngle * -side.direction) / 2; - lowerAngle = upperAngle = angle; } - /// The total angle of the arc motion. - static const _sweepingAngle = math.pi / 3.5; - final BoardSide side; } +/// {@template flipper_joint} +/// [RevoluteJoint] that controls the arc motion of a [Flipper]. +/// {@endtemplate} class _FlipperJoint extends RevoluteJoint { + /// {@macro flipper_joint} _FlipperJoint(_FlipperAnchorRevoluteJointDef def) : side = def.side, - super(def); + super(def) { + lock(); + } + + /// The total angle of the arc motion. + static const _sweepingAngle = math.pi / 3.5; final BoardSide side; - // TODO(alestiago): Remove once Forge2D supports custom joints. - void create(World world) { - world.joints.add(this); - bodyA.joints.add(this); - bodyB.joints.add(this); + /// Locks the [Flipper] to its resting position. + /// + /// The joint is locked when initialized in order to force the [Flipper] + /// at its resting position. + void lock() { + const angle = _sweepingAngle / 2; + setLimits( + -angle * side.direction, + -angle * side.direction, + ); } /// Unlocks the [Flipper] from its resting position. - /// - /// The [Flipper] is locked when initialized in order to force it to be at - /// its resting position. void unlock() { - setLimits( - lowerLimit * side.direction, - -upperLimit * side.direction, - ); + const angle = _sweepingAngle / 2; + setLimits(-angle, angle); + } +} + +// TODO(alestiago): Remove once Forge2D supports custom joints. +extension on World { + void createJoint2(Joint joint) { + assert(!isLocked, ''); + + joints.add(joint); + + joint.bodyA.joints.add(joint); + joint.bodyB.joints.add(joint); } } diff --git a/lib/game/components/joint_anchor.dart b/packages/pinball_components/lib/src/components/joint_anchor.dart similarity index 100% rename from lib/game/components/joint_anchor.dart rename to packages/pinball_components/lib/src/components/joint_anchor.dart diff --git a/packages/pinball_components/pubspec.yaml b/packages/pinball_components/pubspec.yaml index 1c8dfbe3..849469cc 100644 --- a/packages/pinball_components/pubspec.yaml +++ b/packages/pinball_components/pubspec.yaml @@ -26,6 +26,7 @@ flutter: generate: true assets: - assets/images/ + - assets/images/flipper/ flutter_gen: line_length: 80 diff --git a/packages/pinball_components/sandbox/lib/main.dart b/packages/pinball_components/sandbox/lib/main.dart index 44b594d7..113d61ac 100644 --- a/packages/pinball_components/sandbox/lib/main.dart +++ b/packages/pinball_components/sandbox/lib/main.dart @@ -15,5 +15,6 @@ void main() { addBallStories(dashbook); addLayerStories(dashbook); addEffectsStories(dashbook); + addFlipperStories(dashbook); runApp(dashbook); } diff --git a/packages/pinball_components/sandbox/lib/stories/ball/basic.dart b/packages/pinball_components/sandbox/lib/stories/ball/basic.dart index f133ee3f..73890519 100644 --- a/packages/pinball_components/sandbox/lib/stories/ball/basic.dart +++ b/packages/pinball_components/sandbox/lib/stories/ball/basic.dart @@ -7,8 +7,9 @@ class BasicBallGame extends BasicGame with TapDetector { BasicBallGame({required this.color}); static const info = ''' - Basic example of how a Ball works, tap anywhere on the - screen to spawn a ball into the game. + Basic example of how a Ball works. + + Tap anywhere on the screen to spawn a ball into the game. '''; final Color color; diff --git a/packages/pinball_components/sandbox/lib/stories/flipper/basic.dart b/packages/pinball_components/sandbox/lib/stories/flipper/basic.dart new file mode 100644 index 00000000..0e5587ea --- /dev/null +++ b/packages/pinball_components/sandbox/lib/stories/flipper/basic.dart @@ -0,0 +1,26 @@ +import 'package:flame_forge2d/flame_forge2d.dart'; +import 'package:pinball_components/pinball_components.dart'; +import 'package:sandbox/common/common.dart'; + +class BasicFlipperGame extends BasicGame { + static const info = ''' + Basic example of how a Flipper works. +'''; + + @override + Future onLoad() async { + await super.onLoad(); + + final center = screenToWorld(camera.viewport.canvasSize! / 2); + + final leftFlipper = Flipper(side: BoardSide.left) + ..initialPosition = center - Vector2(Flipper.size.x, 0); + final rightFlipper = Flipper(side: BoardSide.right) + ..initialPosition = center + Vector2(Flipper.size.x, 0); + + await addAll([ + leftFlipper, + rightFlipper, + ]); + } +} diff --git a/packages/pinball_components/sandbox/lib/stories/flipper/flipper.dart b/packages/pinball_components/sandbox/lib/stories/flipper/flipper.dart new file mode 100644 index 00000000..7c8465da --- /dev/null +++ b/packages/pinball_components/sandbox/lib/stories/flipper/flipper.dart @@ -0,0 +1,25 @@ +import 'package:dashbook/dashbook.dart'; +import 'package:flame/game.dart'; +import 'package:sandbox/common/common.dart'; +import 'package:sandbox/stories/flipper/basic.dart'; +import 'package:sandbox/stories/flipper/tracing.dart'; + +void addFlipperStories(Dashbook dashbook) { + dashbook.storiesOf('Flipper') + ..add( + 'Basic', + (context) => GameWidget( + game: BasicFlipperGame(), + ), + codeLink: buildSourceLink('flipper/basic.dart'), + info: BasicFlipperGame.info, + ) + ..add( + 'Tracing', + (context) => GameWidget( + game: FlipperTracingGame(), + ), + codeLink: buildSourceLink('flipper/tracing.dart'), + info: FlipperTracingGame.info, + ); +} diff --git a/packages/pinball_components/sandbox/lib/stories/flipper/tracing.dart b/packages/pinball_components/sandbox/lib/stories/flipper/tracing.dart new file mode 100644 index 00000000..d6c5d3df --- /dev/null +++ b/packages/pinball_components/sandbox/lib/stories/flipper/tracing.dart @@ -0,0 +1,49 @@ +import 'dart:async'; + +import 'package:flame/components.dart'; +import 'package:flame_forge2d/flame_forge2d.dart'; +import 'package:flutter/material.dart'; +import 'package:pinball_components/pinball_components.dart'; +import 'package:sandbox/common/common.dart'; + +class FlipperTracingGame extends BasicGame { + static const info = ''' + Basic example of how the Flipper body overlays the sprite. +'''; + + @override + Future onLoad() async { + await super.onLoad(); + final center = screenToWorld(camera.viewport.canvasSize! / 2); + + final leftFlipper = Flipper(side: BoardSide.left) + ..initialPosition = center - Vector2(Flipper.size.x, 0); + final rightFlipper = Flipper(side: BoardSide.right) + ..initialPosition = center + Vector2(Flipper.size.x, 0); + + await addAll([ + leftFlipper, + rightFlipper, + ]); + leftFlipper.trace(); + rightFlipper.trace(); + } +} + +extension on BodyComponent { + void trace({Color color = Colors.red}) { + paint = Paint()..color = color; + renderBody = true; + body.joints.whereType().forEach( + (joint) => joint.setLimits(0, 0), + ); + body.setType(BodyType.static); + + unawaited( + mounted.whenComplete(() { + final sprite = children.whereType().first; + sprite.paint.color = sprite.paint.color.withOpacity(0.5); + }), + ); + } +} diff --git a/packages/pinball_components/sandbox/lib/stories/layer/basic.dart b/packages/pinball_components/sandbox/lib/stories/layer/basic.dart index 89ef337f..ccbd67d9 100644 --- a/packages/pinball_components/sandbox/lib/stories/layer/basic.dart +++ b/packages/pinball_components/sandbox/lib/stories/layer/basic.dart @@ -8,8 +8,9 @@ class BasicLayerGame extends BasicGame with TapDetector { BasicLayerGame({required this.color}); static const info = ''' - Basic example of how layers work with a Ball hitting other components, - tap anywhere on the screen to spawn a ball into the game. + Basic example of how layers work when a Ball hits other components. + + Tap anywhere on the screen to spawn a ball into the game. '''; final Color color; diff --git a/packages/pinball_components/sandbox/lib/stories/stories.dart b/packages/pinball_components/sandbox/lib/stories/stories.dart index 1135fbaf..9f861bde 100644 --- a/packages/pinball_components/sandbox/lib/stories/stories.dart +++ b/packages/pinball_components/sandbox/lib/stories/stories.dart @@ -1,2 +1,3 @@ export 'ball/ball.dart'; +export 'flipper/flipper.dart'; export 'layer/layer.dart'; diff --git a/test/game/components/board_side_test.dart b/packages/pinball_components/test/src/components/board_side_test.dart similarity index 92% rename from test/game/components/board_side_test.dart rename to packages/pinball_components/test/src/components/board_side_test.dart index ba201065..7c17828d 100644 --- a/test/game/components/board_side_test.dart +++ b/packages/pinball_components/test/src/components/board_side_test.dart @@ -1,5 +1,5 @@ import 'package:flutter_test/flutter_test.dart'; -import 'package:pinball/game/game.dart'; +import 'package:pinball_components/pinball_components.dart'; void main() { group( diff --git a/packages/pinball_components/test/src/components/flipper_test.dart b/packages/pinball_components/test/src/components/flipper_test.dart new file mode 100644 index 00000000..efd4d2b0 --- /dev/null +++ b/packages/pinball_components/test/src/components/flipper_test.dart @@ -0,0 +1,133 @@ +// ignore_for_file: cascade_invocations + +import 'package:flame_forge2d/flame_forge2d.dart'; +import 'package:flame_test/flame_test.dart'; +import 'package:flutter/material.dart'; +import 'package:flutter_test/flutter_test.dart'; +import 'package:pinball_components/pinball_components.dart'; + +import '../../helpers/helpers.dart'; + +void main() { + TestWidgetsFlutterBinding.ensureInitialized(); + final flameTester = FlameTester(TestGame.new); + + group('Flipper', () { + // TODO(alestiago): Add golden tests. + // TODO(alestiago): Consider testing always both left and right Flipper. + + flameTester.test( + 'loads correctly', + (game) async { + final leftFlipper = Flipper(side: BoardSide.left); + final rightFlipper = Flipper(side: BoardSide.right); + await game.ready(); + await game.ensureAddAll([leftFlipper, rightFlipper]); + + expect(game.contains(leftFlipper), isTrue); + expect(game.contains(rightFlipper), isTrue); + }, + ); + + group('constructor', () { + test('sets BoardSide', () { + final leftFlipper = Flipper(side: BoardSide.left); + expect(leftFlipper.side, equals(leftFlipper.side)); + + final rightFlipper = Flipper(side: BoardSide.right); + expect(rightFlipper.side, equals(rightFlipper.side)); + }); + }); + + group('body', () { + flameTester.test( + 'is dynamic', + (game) async { + final flipper = Flipper(side: BoardSide.left); + await game.ensureAdd(flipper); + expect(flipper.body.bodyType, equals(BodyType.dynamic)); + }, + ); + + flameTester.test( + 'ignores gravity', + (game) async { + final flipper = Flipper(side: BoardSide.left); + await game.ensureAdd(flipper); + + expect(flipper.body.gravityScale, isZero); + }, + ); + + flameTester.test( + 'has greater mass than Ball', + (game) async { + final flipper = Flipper(side: BoardSide.left); + final ball = Ball(baseColor: Colors.white); + + await game.ready(); + await game.ensureAddAll([flipper, ball]); + + expect( + flipper.body.getMassData().mass, + greaterThan(ball.body.getMassData().mass), + ); + }, + ); + }); + + group('fixtures', () { + flameTester.test( + 'has three', + (game) async { + final flipper = Flipper(side: BoardSide.left); + await game.ensureAdd(flipper); + + expect(flipper.body.fixtures.length, equals(3)); + }, + ); + + flameTester.test( + 'has density', + (game) async { + final flipper = Flipper(side: BoardSide.left); + await game.ensureAdd(flipper); + + final fixtures = flipper.body.fixtures; + final density = fixtures.fold( + 0, + (sum, fixture) => sum + fixture.density, + ); + + expect(density, greaterThan(0)); + }, + ); + }); + + flameTester.test( + 'moveDown applies downward velocity', + (game) async { + final flipper = Flipper(side: BoardSide.left); + await game.ensureAdd(flipper); + + expect(flipper.body.linearVelocity, equals(Vector2.zero())); + flipper.moveDown(); + + expect(flipper.body.linearVelocity.y, lessThan(0)); + }, + ); + + flameTester.test( + 'moveUp applies upward velocity', + (game) async { + final flipper = Flipper(side: BoardSide.left); + await game.ensureAdd(flipper); + + expect(flipper.body.linearVelocity, equals(Vector2.zero())); + flipper.moveUp(); + + expect(flipper.body.linearVelocity.y, greaterThan(0)); + }, + ); + }); +} diff --git a/test/game/components/joint_anchor_test.dart b/packages/pinball_components/test/src/components/joint_anchor_test.dart similarity index 94% rename from test/game/components/joint_anchor_test.dart rename to packages/pinball_components/test/src/components/joint_anchor_test.dart index 652bd445..f7c341dd 100644 --- a/test/game/components/joint_anchor_test.dart +++ b/packages/pinball_components/test/src/components/joint_anchor_test.dart @@ -3,7 +3,7 @@ import 'package:flame_forge2d/flame_forge2d.dart'; import 'package:flame_test/flame_test.dart'; import 'package:flutter_test/flutter_test.dart'; -import 'package:pinball/game/game.dart'; +import 'package:pinball_components/pinball_components.dart'; void main() { TestWidgetsFlutterBinding.ensureInitialized(); diff --git a/test/game/components/baseboard_test.dart b/test/game/components/baseboard_test.dart index f834a41e..37c3c978 100644 --- a/test/game/components/baseboard_test.dart +++ b/test/game/components/baseboard_test.dart @@ -4,6 +4,7 @@ import 'package:flame_forge2d/flame_forge2d.dart'; import 'package:flame_test/flame_test.dart'; import 'package:flutter_test/flutter_test.dart'; import 'package:pinball/game/game.dart'; +import 'package:pinball_components/pinball_components.dart'; void main() { group('Baseboard', () { diff --git a/test/game/components/board_test.dart b/test/game/components/board_test.dart index f6304cec..7b74d0da 100644 --- a/test/game/components/board_test.dart +++ b/test/game/components/board_test.dart @@ -3,6 +3,7 @@ import 'package:flame_test/flame_test.dart'; import 'package:flutter_test/flutter_test.dart'; import 'package:pinball/game/game.dart'; +import 'package:pinball_components/pinball_components.dart'; import '../../helpers/helpers.dart'; diff --git a/test/game/components/bonus_word_test.dart b/test/game/components/bonus_word_test.dart index 293062ae..001ccd46 100644 --- a/test/game/components/bonus_word_test.dart +++ b/test/game/components/bonus_word_test.dart @@ -29,6 +29,7 @@ void main() { group('listenWhen', () { final previousState = MockGameState(); final currentState = MockGameState(); + test( 'returns true when there is a new word bonus awarded', () { diff --git a/test/game/components/flipper_controller_test.dart b/test/game/components/flipper_controller_test.dart new file mode 100644 index 00000000..eabeca5e --- /dev/null +++ b/test/game/components/flipper_controller_test.dart @@ -0,0 +1,169 @@ +import 'dart:collection'; + +import 'package:flame_test/flame_test.dart'; +import 'package:flutter/services.dart'; +import 'package:flutter_test/flutter_test.dart'; +import 'package:pinball/game/game.dart'; +import 'package:pinball_components/pinball_components.dart'; + +import '../../helpers/helpers.dart'; + +void main() { + TestWidgetsFlutterBinding.ensureInitialized(); + final flameTester = FlameTester(PinballGameTest.create); + + group('FlipperController', () { + group('onKeyEvent', () { + final leftKeys = UnmodifiableListView([ + LogicalKeyboardKey.arrowLeft, + LogicalKeyboardKey.keyA, + ]); + final rightKeys = UnmodifiableListView([ + LogicalKeyboardKey.arrowRight, + LogicalKeyboardKey.keyD, + ]); + + group('and Flipper is left', () { + late Flipper flipper; + late FlipperController controller; + + setUp(() { + flipper = Flipper(side: BoardSide.left); + controller = FlipperController(flipper); + flipper.add(controller); + }); + + testRawKeyDownEvents(leftKeys, (event) { + flameTester.test( + 'moves upwards ' + 'when ${event.logicalKey.keyLabel} is pressed', + (game) async { + await game.ready(); + await game.add(flipper); + controller.onKeyEvent(event, {}); + + expect(flipper.body.linearVelocity.y, isPositive); + expect(flipper.body.linearVelocity.x, isZero); + }, + ); + }); + + testRawKeyUpEvents(leftKeys, (event) { + flameTester.test( + 'moves downwards ' + 'when ${event.logicalKey.keyLabel} is released', + (game) async { + await game.ready(); + await game.add(flipper); + controller.onKeyEvent(event, {}); + + expect(flipper.body.linearVelocity.y, isNegative); + expect(flipper.body.linearVelocity.x, isZero); + }, + ); + }); + + testRawKeyUpEvents(rightKeys, (event) { + flameTester.test( + 'does nothing ' + 'when ${event.logicalKey.keyLabel} is released', + (game) async { + await game.ready(); + await game.add(flipper); + controller.onKeyEvent(event, {}); + + expect(flipper.body.linearVelocity.y, isZero); + expect(flipper.body.linearVelocity.x, isZero); + }, + ); + }); + + testRawKeyDownEvents(rightKeys, (event) { + flameTester.test( + 'does nothing ' + 'when ${event.logicalKey.keyLabel} is pressed', + (game) async { + await game.ready(); + await game.add(flipper); + controller.onKeyEvent(event, {}); + + expect(flipper.body.linearVelocity.y, isZero); + expect(flipper.body.linearVelocity.x, isZero); + }, + ); + }); + }); + + group('and Flipper is right', () { + late Flipper flipper; + late FlipperController controller; + + setUp(() { + flipper = Flipper(side: BoardSide.right); + controller = FlipperController(flipper); + flipper.add(controller); + }); + + testRawKeyDownEvents(rightKeys, (event) { + flameTester.test( + 'moves upwards ' + 'when ${event.logicalKey.keyLabel} is pressed', + (game) async { + await game.ready(); + await game.add(flipper); + controller.onKeyEvent(event, {}); + + expect(flipper.body.linearVelocity.y, isPositive); + expect(flipper.body.linearVelocity.x, isZero); + }, + ); + }); + + testRawKeyUpEvents(rightKeys, (event) { + flameTester.test( + 'moves downwards ' + 'when ${event.logicalKey.keyLabel} is released', + (game) async { + await game.ready(); + await game.add(flipper); + controller.onKeyEvent(event, {}); + + expect(flipper.body.linearVelocity.y, isNegative); + expect(flipper.body.linearVelocity.x, isZero); + }, + ); + }); + + testRawKeyUpEvents(leftKeys, (event) { + flameTester.test( + 'does nothing ' + 'when ${event.logicalKey.keyLabel} is released', + (game) async { + await game.ready(); + await game.add(flipper); + controller.onKeyEvent(event, {}); + + expect(flipper.body.linearVelocity.y, isZero); + expect(flipper.body.linearVelocity.x, isZero); + }, + ); + }); + + testRawKeyDownEvents(leftKeys, (event) { + flameTester.test( + 'does nothing ' + 'when ${event.logicalKey.keyLabel} is pressed', + (game) async { + await game.ready(); + await game.add(flipper); + controller.onKeyEvent(event, {}); + + expect(flipper.body.linearVelocity.y, isZero); + expect(flipper.body.linearVelocity.x, isZero); + }, + ); + }); + }); + }); + }); +} diff --git a/test/game/components/flipper_test.dart b/test/game/components/flipper_test.dart deleted file mode 100644 index 3e6429df..00000000 --- a/test/game/components/flipper_test.dart +++ /dev/null @@ -1,275 +0,0 @@ -// ignore_for_file: cascade_invocations - -import 'dart:collection'; - -import 'package:flame_forge2d/flame_forge2d.dart'; -import 'package:flame_test/flame_test.dart'; -import 'package:flutter/material.dart'; -import 'package:flutter/services.dart'; -import 'package:flutter_test/flutter_test.dart'; -import 'package:pinball/game/game.dart'; -import 'package:pinball_components/pinball_components.dart'; - -import '../../helpers/helpers.dart'; - -void main() { - TestWidgetsFlutterBinding.ensureInitialized(); - final flameTester = FlameTester(PinballGameTest.create); - - group( - 'Flipper', - () { - // TODO(alestiago): Add golden tests. - flameTester.test( - 'loads correctly', - (game) async { - final leftFlipper = Flipper( - side: BoardSide.left, - ); - final rightFlipper = Flipper( - side: BoardSide.right, - ); - await game.ready(); - await game.ensureAddAll([leftFlipper, rightFlipper]); - - expect(game.contains(leftFlipper), isTrue); - expect(game.contains(rightFlipper), isTrue); - }, - ); - - group('constructor', () { - test('sets BoardSide', () { - final leftFlipper = Flipper( - side: BoardSide.left, - ); - - expect(leftFlipper.side, equals(leftFlipper.side)); - - final rightFlipper = Flipper( - side: BoardSide.right, - ); - expect(rightFlipper.side, equals(rightFlipper.side)); - }); - }); - - group('body', () { - flameTester.test( - 'is dynamic', - (game) async { - final flipper = Flipper( - side: BoardSide.left, - ); - await game.ensureAdd(flipper); - - expect(flipper.body.bodyType, equals(BodyType.dynamic)); - }, - ); - - flameTester.test( - 'ignores gravity', - (game) async { - final flipper = Flipper( - side: BoardSide.left, - ); - await game.ensureAdd(flipper); - - expect(flipper.body.gravityScale, isZero); - }, - ); - - flameTester.test( - 'has greater mass than Ball', - (game) async { - final flipper = Flipper( - side: BoardSide.left, - ); - final ball = Ball(baseColor: Colors.white); - - await game.ready(); - await game.ensureAddAll([flipper, ball]); - - expect( - flipper.body.getMassData().mass, - greaterThan(ball.body.getMassData().mass), - ); - }, - ); - }); - - group('fixtures', () { - flameTester.test( - 'has three', - (game) async { - final flipper = Flipper( - side: BoardSide.left, - ); - await game.ensureAdd(flipper); - - expect(flipper.body.fixtures.length, equals(3)); - }, - ); - - flameTester.test( - 'has density', - (game) async { - final flipper = Flipper( - side: BoardSide.left, - ); - await game.ensureAdd(flipper); - - final fixtures = flipper.body.fixtures; - final density = fixtures.fold( - 0, - (sum, fixture) => sum + fixture.density, - ); - - expect(density, greaterThan(0)); - }, - ); - }); - - group('onKeyEvent', () { - final leftKeys = UnmodifiableListView([ - LogicalKeyboardKey.arrowLeft, - LogicalKeyboardKey.keyA, - ]); - final rightKeys = UnmodifiableListView([ - LogicalKeyboardKey.arrowRight, - LogicalKeyboardKey.keyD, - ]); - - group('and Flipper is left', () { - late Flipper flipper; - - setUp(() { - flipper = Flipper( - side: BoardSide.left, - ); - }); - - testRawKeyDownEvents(leftKeys, (event) { - flameTester.test( - 'moves upwards ' - 'when ${event.logicalKey.keyLabel} is pressed', - (game) async { - await game.ensureAdd(flipper); - flipper.onKeyEvent(event, {}); - - expect(flipper.body.linearVelocity.y, isPositive); - expect(flipper.body.linearVelocity.x, isZero); - }, - ); - }); - - testRawKeyUpEvents(leftKeys, (event) { - flameTester.test( - 'moves downwards ' - 'when ${event.logicalKey.keyLabel} is released', - (game) async { - await game.ensureAdd(flipper); - flipper.onKeyEvent(event, {}); - - expect(flipper.body.linearVelocity.y, isNegative); - expect(flipper.body.linearVelocity.x, isZero); - }, - ); - }); - - testRawKeyUpEvents(rightKeys, (event) { - flameTester.test( - 'does nothing ' - 'when ${event.logicalKey.keyLabel} is released', - (game) async { - await game.ensureAdd(flipper); - flipper.onKeyEvent(event, {}); - - expect(flipper.body.linearVelocity.y, isZero); - expect(flipper.body.linearVelocity.x, isZero); - }, - ); - }); - - testRawKeyDownEvents(rightKeys, (event) { - flameTester.test( - 'does nothing ' - 'when ${event.logicalKey.keyLabel} is pressed', - (game) async { - await game.ensureAdd(flipper); - flipper.onKeyEvent(event, {}); - - expect(flipper.body.linearVelocity.y, isZero); - expect(flipper.body.linearVelocity.x, isZero); - }, - ); - }); - }); - - group('and Flipper is right', () { - late Flipper flipper; - - setUp(() { - flipper = Flipper( - side: BoardSide.right, - ); - }); - - testRawKeyDownEvents(rightKeys, (event) { - flameTester.test( - 'moves upwards ' - 'when ${event.logicalKey.keyLabel} is pressed', - (game) async { - await game.ensureAdd(flipper); - flipper.onKeyEvent(event, {}); - - expect(flipper.body.linearVelocity.y, isPositive); - expect(flipper.body.linearVelocity.x, isZero); - }, - ); - }); - - testRawKeyUpEvents(rightKeys, (event) { - flameTester.test( - 'moves downwards ' - 'when ${event.logicalKey.keyLabel} is released', - (game) async { - await game.ensureAdd(flipper); - flipper.onKeyEvent(event, {}); - - expect(flipper.body.linearVelocity.y, isNegative); - expect(flipper.body.linearVelocity.x, isZero); - }, - ); - }); - - testRawKeyUpEvents(leftKeys, (event) { - flameTester.test( - 'does nothing ' - 'when ${event.logicalKey.keyLabel} is released', - (game) async { - await game.ensureAdd(flipper); - flipper.onKeyEvent(event, {}); - - expect(flipper.body.linearVelocity.y, isZero); - expect(flipper.body.linearVelocity.x, isZero); - }, - ); - }); - - testRawKeyDownEvents(leftKeys, (event) { - flameTester.test( - 'does nothing ' - 'when ${event.logicalKey.keyLabel} is pressed', - (game) async { - await game.ensureAdd(flipper); - flipper.onKeyEvent(event, {}); - - expect(flipper.body.linearVelocity.y, isZero); - expect(flipper.body.linearVelocity.x, isZero); - }, - ); - }); - }); - }); - }, - ); -} diff --git a/test/game/components/kicker_test.dart b/test/game/components/kicker_test.dart index 211ff8ad..333c7fbe 100644 --- a/test/game/components/kicker_test.dart +++ b/test/game/components/kicker_test.dart @@ -4,6 +4,7 @@ import 'package:flame_forge2d/flame_forge2d.dart'; import 'package:flame_test/flame_test.dart'; import 'package:flutter_test/flutter_test.dart'; import 'package:pinball/game/game.dart'; +import 'package:pinball_components/pinball_components.dart'; void main() { group('Kicker', () {