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

fix: Add key parameters to the rest of the components #3170

Merged
merged 4 commits into from
May 27, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ class BoundedPositionBehavior extends Component {
PositionProvider? target,
double precision = 0.5,
super.priority,
super.key,
}) : assert(precision > 0, 'Precision must be positive: $precision'),
_bounds = bounds,
_target = target,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ class FollowBehavior extends Component {
this.horizontalOnly = false,
this.verticalOnly = false,
super.priority,
super.key,
}) : _target = target,
_owner = owner,
_speed = maxSpeed,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ class ViewportAwareBoundsBehavior extends Component with ParentIsA<Viewfinder> {

ViewportAwareBoundsBehavior({
required Shape boundsShape,
super.key,
}) : _boundsShape = boundsShape;

@override
Expand Down
3 changes: 3 additions & 0 deletions packages/flame/lib/src/camera/camera_component.dart
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@ class CameraComponent extends Component {
Viewfinder? viewfinder,
Component? backdrop,
List<Component>? hudComponents,
super.key,
}) : _viewport = (viewport ?? MaxViewport())..addAll(hudComponents ?? []),
_viewfinder = viewfinder ?? Viewfinder(),
_backdrop = backdrop ?? Component(),
Expand Down Expand Up @@ -74,12 +75,14 @@ class CameraComponent extends Component {
Viewfinder? viewfinder,
Component? backdrop,
List<Component>? hudComponents,
ComponentKey? key,
}) : this(
world: world,
viewport: FixedResolutionViewport(resolution: Vector2(width, height)),
viewfinder: viewfinder ?? Viewfinder(),
backdrop: backdrop,
hudComponents: hudComponents,
key: key,
);

/// The [viewport] is the "window" through which the game world is observed.
Expand Down
4 changes: 4 additions & 0 deletions packages/flame/lib/src/camera/viewfinder.dart
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,10 @@ class Viewfinder extends Component
PositionProvider,
ScaleProvider,
CoordinateTransform {
Viewfinder({
super.key,
});

/// Transform matrix used by the viewfinder.
final Transform2D transform = Transform2D();

Expand Down
5 changes: 4 additions & 1 deletion packages/flame/lib/src/camera/viewport.dart
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,10 @@ abstract class Viewport extends Component
PositionProvider,
SizeProvider,
CoordinateTransform {
Viewport({super.children});
Viewport({
super.children,
super.key,
});

final Vector2 _size = Vector2.zero();
bool _isInitialized = false;
Expand Down
1 change: 1 addition & 0 deletions packages/flame/lib/src/camera/world.dart
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ class World extends Component implements CoordinateTransform {
World({
super.children,
super.priority = -0x7fffffff,
super.key,
});

@override
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,10 @@ import 'package:meta/meta.dart';
/// functionality, namely: it contains global lifecycle events for the component
/// tree.
class ComponentTreeRoot extends Component {
ComponentTreeRoot({super.children})
: _queue = RecycledQueue(_LifecycleEvent.new),
ComponentTreeRoot({
super.children,
super.key,
}) : _queue = RecycledQueue(_LifecycleEvent.new),
_blocked = <int>{},
_componentsToRebalance = <Component>{};

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ class KeyboardListenerComponent extends Component with KeyboardHandler {
KeyboardListenerComponent({
Map<LogicalKeyboardKey, KeyHandlerCallback> keyUp = const {},
Map<LogicalKeyboardKey, KeyHandlerCallback> keyDown = const {},
super.key,
}) : _keyUp = keyUp,
_keyDown = keyDown;

Expand Down
1 change: 1 addition & 0 deletions packages/flame/lib/src/effects/anchor_by_effect.dart
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ class AnchorByEffect extends AnchorEffect {
EffectController controller, {
AnchorProvider? target,
void Function()? onComplete,
super.key,
}) : _offset = offset.clone(),
super(controller, target, onComplete: onComplete);

Expand Down
8 changes: 6 additions & 2 deletions packages/flame/lib/src/effects/anchor_effect.dart
Original file line number Diff line number Diff line change
@@ -1,12 +1,11 @@
import 'package:flame/src/anchor.dart';
import 'package:flame/components.dart';
import 'package:flame/src/effects/anchor_by_effect.dart';
import 'package:flame/src/effects/anchor_to_effect.dart';
import 'package:flame/src/effects/controllers/effect_controller.dart';
import 'package:flame/src/effects/effect.dart';
import 'package:flame/src/effects/effect_target.dart';
import 'package:flame/src/effects/measurable_effect.dart';
import 'package:flame/src/effects/provider_interfaces.dart';
import 'package:vector_math/vector_math_64.dart';

/// Base class for effects that affect the `anchor` of their targets.
///
Expand All @@ -22,6 +21,7 @@ abstract class AnchorEffect extends Effect
super.controller,
AnchorProvider? target, {
super.onComplete,
super.key,
}) {
this.target = target;
}
Expand All @@ -31,24 +31,28 @@ abstract class AnchorEffect extends Effect
EffectController controller, {
AnchorProvider? target,
void Function()? onComplete,
ComponentKey? key,
}) =>
AnchorByEffect(
offset,
controller,
target: target,
onComplete: onComplete,
key: key,
);

factory AnchorEffect.to(
Anchor destination,
EffectController controller, {
AnchorProvider? target,
void Function()? onComplete,
ComponentKey? key,
}) =>
AnchorToEffect(
destination,
controller,
target: target,
onComplete: onComplete,
key: key,
);
}
1 change: 1 addition & 0 deletions packages/flame/lib/src/effects/anchor_to_effect.dart
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ class AnchorToEffect extends AnchorEffect {
EffectController controller, {
AnchorProvider? target,
void Function()? onComplete,
super.key,
}) : _destination = destination,
super(controller, target, onComplete: onComplete);

Expand Down
1 change: 1 addition & 0 deletions packages/flame/lib/src/effects/color_effect.dart
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ class ColorEffect extends ComponentEffect<HasPaint> {
double opacityTo = 1,
this.paintId,
void Function()? onComplete,
super.key,
}) : assert(
opacityFrom >= 0 &&
opacityFrom <= 1 &&
Expand Down
1 change: 1 addition & 0 deletions packages/flame/lib/src/effects/component_effect.dart
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ abstract class ComponentEffect<T extends Component> extends Effect {
ComponentEffect(
super.controller, {
super.onComplete,
super.key,
});

late T target;
Expand Down
9 changes: 6 additions & 3 deletions packages/flame/lib/src/effects/effect.dart
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,11 @@ import 'package:meta/meta.dart';
/// changes in the effect's target; and also the `reset()` method if they have
/// non-trivial internal state.
abstract class Effect extends Component {
Effect(this.controller, {this.onComplete})
: removeOnFinish = true,
Effect(
this.controller, {
this.onComplete,
super.key,
}) : removeOnFinish = true,
_paused = false,
_started = false,
_finished = false {
Expand Down Expand Up @@ -210,5 +213,5 @@ abstract class Effect extends Component {
/// This is a main method that MUST be implemented in every derived class.
void apply(double progress);

//#endregion
//#endregion
}
7 changes: 6 additions & 1 deletion packages/flame/lib/src/effects/glow_effect.dart
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,12 @@ import 'package:meta/meta.dart';
/// same component also used incremental updates.
@experimental
class GlowEffect extends Effect with EffectTarget<PaintProvider> {
GlowEffect(this.strength, super.controller, {this.style = BlurStyle.outer});
GlowEffect(
this.strength,
super.controller, {
this.style = BlurStyle.outer,
super.key,
});

final BlurStyle style;
final double strength;
Expand Down
1 change: 1 addition & 0 deletions packages/flame/lib/src/effects/move_along_path_effect.dart
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ class MoveAlongPathEffect extends MoveEffect {
bool oriented = false,
PositionProvider? target,
void Function()? onComplete,
super.key,
}) : _isAbsolute = absolute,
_followDirection = oriented,
super(
Expand Down
1 change: 1 addition & 0 deletions packages/flame/lib/src/effects/move_by_effect.dart
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ class MoveByEffect extends MoveEffect {
EffectController controller, {
PositionProvider? target,
void Function()? onComplete,
super.key,
}) : _offset = offset.clone(),
super(controller, target, onComplete: onComplete);

Expand Down
7 changes: 6 additions & 1 deletion packages/flame/lib/src/effects/move_effect.dart
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
import 'package:flame/components.dart';
import 'package:flame/src/effects/controllers/effect_controller.dart';
import 'package:flame/src/effects/effect.dart';
import 'package:flame/src/effects/effect_target.dart';
import 'package:flame/src/effects/measurable_effect.dart';
import 'package:flame/src/effects/move_by_effect.dart';
import 'package:flame/src/effects/move_to_effect.dart';
import 'package:flame/src/effects/provider_interfaces.dart';
import 'package:vector_math/vector_math_64.dart';

/// Base class for effects that affect the `position` of their targets.
///
Expand All @@ -21,6 +21,7 @@ abstract class MoveEffect extends Effect
super.controller,
PositionProvider? target, {
super.onComplete,
super.key,
}) {
this.target = target;
}
Expand All @@ -30,24 +31,28 @@ abstract class MoveEffect extends Effect
EffectController controller, {
PositionProvider? target,
void Function()? onComplete,
ComponentKey? key,
}) =>
MoveByEffect(
offset,
controller,
target: target,
onComplete: onComplete,
key: key,
);

factory MoveEffect.to(
Vector2 destination,
EffectController controller, {
PositionProvider? target,
void Function()? onComplete,
ComponentKey? key,
}) =>
MoveToEffect(
destination,
controller,
target: target,
onComplete: onComplete,
key: key,
);
}
1 change: 1 addition & 0 deletions packages/flame/lib/src/effects/move_to_effect.dart
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ class MoveToEffect extends MoveEffect {
EffectController controller, {
PositionProvider? target,
void Function()? onComplete,
super.key,
}) : _destination = destination.clone(),
_offset = Vector2.zero(),
super(controller, target, onComplete: onComplete);
Expand Down
9 changes: 9 additions & 0 deletions packages/flame/lib/src/effects/opacity_effect.dart
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import 'package:flame/components.dart';
import 'package:flame/effects.dart';

/// Change the opacity of a component over time.
Expand All @@ -13,6 +14,7 @@ class OpacityEffect extends Effect with EffectTarget<OpacityProvider> {
super.controller, {
OpacityProvider? target,
super.onComplete,
super.key,
}) : _opacityOffset = offset {
this.target = target;
}
Expand All @@ -23,38 +25,44 @@ class OpacityEffect extends Effect with EffectTarget<OpacityProvider> {
EffectController controller, {
OpacityProvider? target,
void Function()? onComplete,
ComponentKey? key,
}) {
return _OpacityToEffect(
targetOpacity,
controller,
target: target,
onComplete: onComplete,
key: key,
);
}

factory OpacityEffect.fadeIn(
EffectController controller, {
OpacityProvider? target,
void Function()? onComplete,
ComponentKey? key,
}) {
return _OpacityToEffect(
1.0,
controller,
target: target,
onComplete: onComplete,
key: key,
);
}

factory OpacityEffect.fadeOut(
EffectController controller, {
OpacityProvider? target,
void Function()? onComplete,
ComponentKey? key,
}) {
return _OpacityToEffect(
0.0,
controller,
target: target,
onComplete: onComplete,
key: key,
);
}

Expand Down Expand Up @@ -89,6 +97,7 @@ class _OpacityToEffect extends OpacityEffect {
EffectController controller, {
OpacityProvider? target,
void Function()? onComplete,
super.key,
}) : super.by(
0.0,
controller,
Expand Down
1 change: 1 addition & 0 deletions packages/flame/lib/src/effects/remove_effect.dart
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ class RemoveEffect extends ComponentEffect {
RemoveEffect({
double delay = 0.0,
void Function()? onComplete,
super.key,
}) : super(
LinearEffectController(delay),
onComplete: onComplete,
Expand Down
5 changes: 5 additions & 0 deletions packages/flame/lib/src/effects/rotate_effect.dart
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import 'package:flame/components.dart';
import 'package:flame/src/effects/controllers/effect_controller.dart';
import 'package:flame/src/effects/effect.dart';
import 'package:flame/src/effects/effect_target.dart';
Expand Down Expand Up @@ -25,17 +26,20 @@ class RotateEffect extends Effect
double angle,
super.controller, {
super.onComplete,
super.key,
}) : _angle = angle;

factory RotateEffect.to(
double angle,
EffectController controller, {
void Function()? onComplete,
ComponentKey? key,
}) {
return _RotateToEffect(
angle,
controller,
onComplete: onComplete,
key: key,
);
}

Expand All @@ -58,6 +62,7 @@ class _RotateToEffect extends RotateEffect {
double angle,
EffectController controller, {
void Function()? onComplete,
super.key,
}) : _destinationAngle = angle,
super.by(0, controller, onComplete: onComplete);

Expand Down
Loading
Loading