Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat!: The HasTappableComponents mixin is no longer needed #2450

Merged
merged 28 commits into from
Apr 2, 2023
Merged
Show file tree
Hide file tree
Changes from 26 commits
Commits
Show all changes
28 commits
Select commit Hold shift + click to select a range
1db0e81
Wip
spydon Mar 16, 2023
98c924f
Add drag callbacks test for flame game
spydon Mar 19, 2023
29d3d1e
Start fixing up tests
spydon Mar 19, 2023
37cbb85
Remove mixin from examples
spydon Mar 20, 2023
c709d4e
Wip
spydon Mar 20, 2023
fb09503
Merge remote-tracking branch 'origin/main' into spydon/deprecate-hast…
spydon Mar 20, 2023
43b8076
Set up MultiTapDispatcher
spydon Mar 28, 2023
9e28bd5
Merge branch 'main' into spydon/deprecate-hastappablecomponents
spydon Mar 28, 2023
2c86876
Fix remaining tests
spydon Mar 28, 2023
ac86f98
Fix this -> in HasTappableComponents
spydon Mar 28, 2023
3f2078b
Fix test asserts
spydon Mar 29, 2023
09fa53d
Update docs
spydon Mar 29, 2023
6e93ff0
Fix tests
spydon Mar 30, 2023
6cf97b1
Fix joystick test
spydon Mar 30, 2023
137e7a4
Fix markdown linting warnings
spydon Mar 30, 2023
3541e0b
Actually fix them...
spydon Mar 30, 2023
6397f84
Fix joystick test
spydon Mar 30, 2023
a06f275
Merge branch 'main' into spydon/deprecate-hastappablecomponents
spydon Mar 30, 2023
b697146
Remove createTapDownDetails
spydon Mar 31, 2023
daf002f
Merge branch 'main' into spydon/deprecate-hastappablecomponents
spydon Mar 31, 2023
000a430
Merge branch 'main' into spydon/deprecate-hastappablecomponents
spydon Apr 2, 2023
d88c247
Merge branch 'main' into spydon/deprecate-hastappablecomponents
spydon Apr 2, 2023
29ca126
Update doc/flame/inputs/tap_events.md
spydon Apr 2, 2023
f0ba95b
Update docs about containsLocalPoint and PositionComponent
spydon Apr 2, 2023
a309252
Fix example
spydon Apr 2, 2023
81a9926
Update test to use matchers
spydon Apr 2, 2023
ed40685
Merge branch 'main' into spydon/deprecate-hastappablecomponents
spydon Apr 2, 2023
8cc5ea2
Merge branch 'main' into spydon/deprecate-hastappablecomponents
spydon Apr 2, 2023
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions doc/flame/examples/lib/anchor_by_effect.dart
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
import 'package:doc_flame_examples/flower.dart';
import 'package:flame/effects.dart';
import 'package:flame/experimental.dart';
import 'package:flame/game.dart';

class AnchorByEffectGame extends FlameGame with HasTappableComponents {
class AnchorByEffectGame extends FlameGame {
bool reset = false;
@override
Future<void> onLoad() async {
Expand Down
3 changes: 1 addition & 2 deletions doc/flame/examples/lib/anchor_to_effect.dart
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
import 'package:doc_flame_examples/flower.dart';
import 'package:flame/components.dart';
import 'package:flame/effects.dart';
import 'package:flame/experimental.dart';
import 'package:flame/game.dart';

class AnchorToEffectGame extends FlameGame with HasTappableComponents {
class AnchorToEffectGame extends FlameGame {
@override
Future<void> onLoad() async {
final flower = Flower(
Expand Down
4 changes: 1 addition & 3 deletions doc/flame/examples/lib/collision_detection.dart
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,10 @@ import 'package:doc_flame_examples/ember.dart';
import 'package:flame/collisions.dart';
import 'package:flame/components.dart';
import 'package:flame/effects.dart';
import 'package:flame/experimental.dart';
import 'package:flame/game.dart';
import 'package:flutter/material.dart' hide Image, Draggable;

class CollisionDetectionGame extends FlameGame
with HasCollisionDetection, HasTappableComponents {
class CollisionDetectionGame extends FlameGame with HasCollisionDetection {
@override
Future<void> onLoad() async {
final emberPlayer = EmberPlayer(
Expand Down
3 changes: 1 addition & 2 deletions doc/flame/examples/lib/color_effect.dart
Original file line number Diff line number Diff line change
@@ -1,12 +1,11 @@
import 'package:doc_flame_examples/ember.dart';
import 'package:flame/components.dart';
import 'package:flame/effects.dart';
import 'package:flame/experimental.dart';
import 'package:flame/game.dart';
import 'package:flutter/animation.dart';
import 'package:flutter/cupertino.dart';

class ColorEffectExample extends FlameGame with HasTappableComponents {
class ColorEffectExample extends FlameGame {
bool reset = false;

@override
Expand Down
3 changes: 1 addition & 2 deletions doc/flame/examples/lib/decorator_blur.dart
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
import 'package:doc_flame_examples/flower.dart';
import 'package:flame/experimental.dart';
import 'package:flame/game.dart';
import 'package:flame/rendering.dart';

class DecoratorBlurGame extends FlameGame with HasTappableComponents {
class DecoratorBlurGame extends FlameGame {
@override
Future<void> onLoad() async {
var step = 0;
Expand Down
3 changes: 1 addition & 2 deletions doc/flame/examples/lib/decorator_grayscale.dart
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
import 'package:doc_flame_examples/flower.dart';
import 'package:flame/experimental.dart';
import 'package:flame/game.dart';
import 'package:flame/rendering.dart';

class DecoratorGrayscaleGame extends FlameGame with HasTappableComponents {
class DecoratorGrayscaleGame extends FlameGame {
@override
Future<void> onLoad() async {
var step = 0;
Expand Down
3 changes: 1 addition & 2 deletions doc/flame/examples/lib/decorator_rotate3d.dart
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
import 'package:doc_flame_examples/flower.dart';
import 'package:flame/experimental.dart';
import 'package:flame/game.dart';
import 'package:flame/rendering.dart';

class DecoratorRotate3DGame extends FlameGame with HasTappableComponents {
class DecoratorRotate3DGame extends FlameGame {
@override
Future<void> onLoad() async {
var step = 0;
Expand Down
3 changes: 1 addition & 2 deletions doc/flame/examples/lib/decorator_shadow3d.dart
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,10 @@ import 'dart:ui';

import 'package:doc_flame_examples/flower.dart';
import 'package:flame/components.dart';
import 'package:flame/experimental.dart';
import 'package:flame/game.dart';
import 'package:flame/rendering.dart';

class DecoratorShadowGame extends FlameGame with HasTappableComponents {
class DecoratorShadowGame extends FlameGame {
@override
Color backgroundColor() => const Color(0xFFC7C7C7);

Expand Down
3 changes: 1 addition & 2 deletions doc/flame/examples/lib/decorator_tint.dart
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
import 'dart:ui';

import 'package:doc_flame_examples/flower.dart';
import 'package:flame/experimental.dart';
import 'package:flame/game.dart';
import 'package:flame/rendering.dart';

class DecoratorTintGame extends FlameGame with HasTappableComponents {
class DecoratorTintGame extends FlameGame {
@override
Future<void> onLoad() async {
var step = 0;
Expand Down
3 changes: 1 addition & 2 deletions doc/flame/examples/lib/move_along_path_effect.dart
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,9 @@ import 'dart:ui';

import 'package:doc_flame_examples/flower.dart';
import 'package:flame/effects.dart';
import 'package:flame/experimental.dart';
import 'package:flame/game.dart';

class MoveAlongPathEffectGame extends FlameGame with HasTappableComponents {
class MoveAlongPathEffectGame extends FlameGame {
bool reset = false;
@override
Future<void> onLoad() async {
Expand Down
3 changes: 1 addition & 2 deletions doc/flame/examples/lib/move_by_effect.dart
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
import 'package:doc_flame_examples/flower.dart';
import 'package:flame/effects.dart';
import 'package:flame/experimental.dart';
import 'package:flame/game.dart';

class MoveByEffectGame extends FlameGame with HasTappableComponents {
class MoveByEffectGame extends FlameGame {
bool reset = false;
@override
Future<void> onLoad() async {
Expand Down
3 changes: 1 addition & 2 deletions doc/flame/examples/lib/move_to_effect.dart
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
import 'package:doc_flame_examples/flower.dart';
import 'package:flame/effects.dart';
import 'package:flame/experimental.dart';
import 'package:flame/game.dart';

class MoveToEffectGame extends FlameGame with HasTappableComponents {
class MoveToEffectGame extends FlameGame {
bool reset = false;
@override
Future<void> onLoad() async {
Expand Down
3 changes: 1 addition & 2 deletions doc/flame/examples/lib/opacity_by_effect.dart
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
import 'package:doc_flame_examples/ember.dart';
import 'package:flame/components.dart';
import 'package:flame/effects.dart';
import 'package:flame/experimental.dart';
import 'package:flame/game.dart';

class OpacityByEffectGame extends FlameGame with HasTappableComponents {
class OpacityByEffectGame extends FlameGame {
bool reset = false;
@override
Future<void> onLoad() async {
Expand Down
3 changes: 1 addition & 2 deletions doc/flame/examples/lib/opacity_effect_with_target.dart
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
import 'package:doc_flame_examples/flower.dart';
import 'package:flame/components.dart';
import 'package:flame/effects.dart';
import 'package:flame/experimental.dart';
import 'package:flame/game.dart';

class OpacityEffectWithTargetGame extends FlameGame with HasTappableComponents {
class OpacityEffectWithTargetGame extends FlameGame {
bool reset = false;

// This reference needs to be stored because every new instance of
Expand Down
3 changes: 1 addition & 2 deletions doc/flame/examples/lib/opacity_to_effect.dart
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
import 'package:doc_flame_examples/flower.dart';
import 'package:flame/components.dart';
import 'package:flame/effects.dart';
import 'package:flame/experimental.dart';
import 'package:flame/game.dart';

class OpacityToEffectGame extends FlameGame with HasTappableComponents {
class OpacityToEffectGame extends FlameGame {
bool reset = false;

@override
Expand Down
3 changes: 1 addition & 2 deletions doc/flame/examples/lib/rotate_by_effect.dart
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
import 'package:doc_flame_examples/flower.dart';
import 'package:flame/effects.dart';
import 'package:flame/experimental.dart';
import 'package:flame/game.dart';

class RotateByEffectGame extends FlameGame with HasTappableComponents {
class RotateByEffectGame extends FlameGame {
bool reset = false;
@override
Future<void> onLoad() async {
Expand Down
3 changes: 1 addition & 2 deletions doc/flame/examples/lib/rotate_to_effect.dart
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
import 'package:doc_flame_examples/flower.dart';
import 'package:flame/effects.dart';
import 'package:flame/experimental.dart';
import 'package:flame/game.dart';

class RotateToEffectGame extends FlameGame with HasTappableComponents {
class RotateToEffectGame extends FlameGame {
bool reset = false;
@override
Future<void> onLoad() async {
Expand Down
2 changes: 1 addition & 1 deletion doc/flame/examples/lib/router.dart
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import 'package:flame/game.dart';
import 'package:flame/rendering.dart';
import 'package:flutter/rendering.dart';

class RouterGame extends FlameGame with HasTappableComponents {
class RouterGame extends FlameGame {
late final RouterComponent router;

@override
Expand Down
3 changes: 1 addition & 2 deletions doc/flame/examples/lib/scale_by_effect.dart
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
import 'package:doc_flame_examples/flower.dart';
import 'package:flame/effects.dart';
import 'package:flame/experimental.dart';
import 'package:flame/game.dart';

class ScaleByEffectGame extends FlameGame with HasTappableComponents {
class ScaleByEffectGame extends FlameGame {
bool reverse = false;
bool hold = false;
@override
Expand Down
3 changes: 1 addition & 2 deletions doc/flame/examples/lib/scale_to_effect.dart
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
import 'package:doc_flame_examples/flower.dart';
import 'package:flame/effects.dart';
import 'package:flame/experimental.dart';
import 'package:flame/game.dart';

class ScaleToEffectGame extends FlameGame with HasTappableComponents {
class ScaleToEffectGame extends FlameGame {
bool reverse = false;
bool hold = false;
@override
Expand Down
3 changes: 1 addition & 2 deletions doc/flame/examples/lib/sequence_effect.dart
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
import 'package:doc_flame_examples/flower.dart';
import 'package:flame/effects.dart';
import 'package:flame/experimental.dart';
import 'package:flame/game.dart';

class SequenceEffectGame extends FlameGame with HasTappableComponents {
class SequenceEffectGame extends FlameGame {
@override
Future<void> onLoad() async {
final flower = Flower(
Expand Down
3 changes: 1 addition & 2 deletions doc/flame/examples/lib/size_by_effect.dart
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
import 'package:doc_flame_examples/ember.dart';
import 'package:flame/components.dart';
import 'package:flame/effects.dart';
import 'package:flame/experimental.dart';
import 'package:flame/game.dart';

class SizeByEffectGame extends FlameGame with HasTappableComponents {
class SizeByEffectGame extends FlameGame {
bool reset = false;
@override
Future<void> onLoad() async {
Expand Down
3 changes: 1 addition & 2 deletions doc/flame/examples/lib/size_to_effect.dart
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
import 'package:doc_flame_examples/ember.dart';
import 'package:flame/components.dart';
import 'package:flame/effects.dart';
import 'package:flame/experimental.dart';
import 'package:flame/game.dart';

class SizeToEffectGame extends FlameGame with HasTappableComponents {
class SizeToEffectGame extends FlameGame {
bool reset = false;
@override
Future<void> onLoad() async {
Expand Down
9 changes: 3 additions & 6 deletions doc/flame/examples/lib/tap_events.dart
Original file line number Diff line number Diff line change
Expand Up @@ -5,18 +5,15 @@ import 'package:flame/experimental.dart';
import 'package:flame/game.dart';
import 'package:flutter/rendering.dart';

/// The main [FlameGame] class uses [HasTappableComponents] in order to enable
/// tap events propagation.
class TapEventsGame extends FlameGame with HasTappableComponents {
class TapEventsGame extends FlameGame {
@override
Future<void> onLoad() async {
add(TapTarget());
}
}

/// This component is the tappable blue-ish rectangle in the center of the
/// game. It uses the [TapCallbacks] mixin in order to inform the game that it
/// wants to receive tap events.
/// This component is the tappable blue-ish rectangle in the center of the game.
/// It uses the [TapCallbacks] mixin to receive tap events.
class TapTarget extends PositionComponent with TapCallbacks {
TapTarget() : super(anchor: Anchor.center);

Expand Down
3 changes: 1 addition & 2 deletions doc/flame/examples/lib/time_scale.dart
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,9 @@ import 'dart:async';

import 'package:doc_flame_examples/ember.dart';
import 'package:flame/components.dart';
import 'package:flame/experimental.dart';
import 'package:flame/game.dart';

class TimeScaleGame extends FlameGame with HasTimeScale, HasTappableComponents {
class TimeScaleGame extends FlameGame with HasTimeScale {
final _timeScales = [0.5, 1.0, 2.0];
var _index = 1;

Expand Down
2 changes: 1 addition & 1 deletion doc/flame/examples/lib/value_route.dart
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import 'package:flame/components.dart';
import 'package:flame/experimental.dart';
import 'package:flame/game.dart';

class ValueRouteExample extends FlameGame with HasTappableComponents {
class ValueRouteExample extends FlameGame {
late final RouterComponent router;

@override
Expand Down
1 change: 1 addition & 0 deletions doc/flame/examples/pubspec.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ dependencies:

dev_dependencies:
flame_lint: ^0.2.0

flutter:
assets:
- assets/
Expand Down
3 changes: 2 additions & 1 deletion doc/flame/inputs/drag_events.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,8 @@ For those components that you want to respond to drags, add the `DragCallbacks`
- This mixin adds four overridable methods to your component: `onDragStart`, `onDragUpdate`,
`onDragEnd`, and `onDragCancel`. By default, these methods do nothing -- they need to be
overridden in order to perform any function.
- In addition, the component must implement the `containsLocalPoint()` method -- this method
- In addition, the component must implement the `containsLocalPoint()` method (already implemented
in `PositionComponent`, so most of the time you don't need to do anything here) -- this method
allows Flame to know whether the event occurred within the component or not.

```dart
Expand Down
Loading